From dd5bccf70832b791febe928f18b006e3138b5b0b Mon Sep 17 00:00:00 2001
From: yann <yann@needsome.coffee>
Date: Mon, 8 Sep 2025 11:58:02 +0200
Subject: [PATCH] add doctstings

---
 lettings/models.py        |  17 +++++++++++++++++
 lettings/views.py         |  10 ++++++++++
 oc-lettings-site.sqlite3  | Bin 159744 -> 159744 bytes
 oc_lettings_site/views.py |   5 +++++
 profiles/models.py        |   3 +++
 profiles/views.py         |  10 ++++++++++
 6 files changed, 45 insertions(+)

diff --git a/lettings/models.py b/lettings/models.py
index 8e76ef0..52cd338 100644
--- a/lettings/models.py
+++ b/lettings/models.py
@@ -3,6 +3,17 @@ from django.core.validators import MaxValueValidator, MinLengthValidator
 
 
 class Address(models.Model):
+    """
+    Details of the physical location of a property
+    """
+
+    class Meta:
+        """
+        Fix the plural displayed in admin
+        """
+        verbose_name_plural = "Addresses"
+
+
     number = models.PositiveIntegerField(validators=[MaxValueValidator(9999)])
     street = models.CharField(max_length=64)
     city = models.CharField(max_length=64)
@@ -11,12 +22,18 @@ class Address(models.Model):
     country_iso_code = models.CharField(max_length=3, validators=[MinLengthValidator(3)])
 
     def __str__(self):
+        """ Display object with basic address """
         return f'{self.number} {self.street}'
 
 
+
 class Letting(models.Model):
+    """
+    Announce for a property to rent
+    """
     title = models.CharField(max_length=256)
     address = models.OneToOneField(Address, on_delete=models.CASCADE)
 
     def __str__(self):
+        """ display object with title """
         return self.title
diff --git a/lettings/views.py b/lettings/views.py
index c2dba21..40cf443 100644
--- a/lettings/views.py
+++ b/lettings/views.py
@@ -3,12 +3,22 @@ from lettings.models import Letting
 
 
 def index(request):
+    """
+    letting's index page. Retrieve all objects in db then give list to template
+    :param request; None
+    :return: render and display template HTML
+    """
     lettings_list = Letting.objects.all()
     context = {'lettings_list': lettings_list}
     return render(request, 'lettings/index.html', context)
 
 
 def letting(request, letting_id):
+    """
+    display detail of a particular Letting object
+    :param request: None
+    :return: render and display template HTML
+    """
     letting = Letting.objects.get(id=letting_id)
     context = {
         'title': letting.title,
diff --git a/oc-lettings-site.sqlite3 b/oc-lettings-site.sqlite3
index 976ca88adbc3f5000d0c971401ae61a6fef5d8f5..446536f2a73fe67f5f3fe2fbe9999efd785ff0e6 100644
GIT binary patch
delta 255
zcmZp8z}fJCbAmLZ`$QRMM)!>giSq?56b#I*jLfZ!&GgI+j4X}Jn=j4ZerZ0VQ3Dq<
zj~fHuA>I}qw~dV!JQ_{b%&fjGtd5lx#(73r=0-+lIZ2k5hK0FB<wjLzWyWQRIf>;K
zsRi5D=rXY|3K<z8n`~xjYP!8em#Kk?i<y5C1OFZV?fjEAGZwV)YpO8&G7>VA8Kh`>
zk1mtK^xO7Knm{v_Fz`R(Kg_=bXvQ>tc{yfBMk50wQ(Xf~T}+Faw;%RrvQ+>8hH^*X

delta 114
zcmZp8z}fJCbAmLZ%S0JxMwg8ViSq?b6%3863{0#{P4$e7&5bS1nlH`YerZ0VQ3D4P
zZwmw8A>NjajTOAxTXdNkm^hgDw=?kH;orWQv0ybniwd(Z<MbX~CWYy@?U^)zl7|`i
SAMqasN^a-he%PPMRsjGMeIvyH

diff --git a/oc_lettings_site/views.py b/oc_lettings_site/views.py
index 4c96023..c2ef72b 100644
--- a/oc_lettings_site/views.py
+++ b/oc_lettings_site/views.py
@@ -2,4 +2,9 @@ from django.shortcuts import render
 
 
 def index(request):
+    """
+    Main index of app, home page
+    :param request: None
+    :return: render and display homepage
+    """
     return render(request, 'index.html')
diff --git a/profiles/models.py b/profiles/models.py
index 84c85c1..822f2cb 100644
--- a/profiles/models.py
+++ b/profiles/models.py
@@ -3,6 +3,9 @@ from django.contrib.auth.models import User
 
 
 class Profile(models.Model):
+    """
+    Defines a service user
+    """
     user = models.OneToOneField(User, on_delete=models.CASCADE)
     favorite_city = models.CharField(max_length=64, blank=True)
 
diff --git a/profiles/views.py b/profiles/views.py
index 0846566..227e425 100644
--- a/profiles/views.py
+++ b/profiles/views.py
@@ -3,12 +3,22 @@ from profiles.models import Profile
 
 
 def index(request):
+    """
+    Display the list of all profiles
+    :param request: None
+    :return: render and display template as HTML
+    """
     profiles_list = Profile.objects.all()
     context = {'profiles_list': profiles_list}
     return render(request, 'profiles/index.html', context)
 
 
 def profile(request, username):
+    """
+    Display the detail of a give profile
+    :param request: None
+    :return: render and display template as HTML
+    """
     profile = Profile.objects.get(user__username=username)
     context = {'profile': profile}
     return render(request, 'profiles/profile.html', context)