Commander1024/lostplaces-backend
1
0
Fork 0
Code Issues 14 Pull Requests Releases Wiki Activity

Typos and missing docstrings.

Browse Source
This commit is contained in:
Marcus Scholz
2020-09-21 21:37:28 +02:00
parent 85a34b20f9
commit 9632040ade
11 changed files with 43 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
django_lostplaces/docs/developer.md
View File

@@ -13,13 +13,13 @@ The class `lostplaces.models.Explorer` is our custom user profile. It has an For
You can access the explorer profile by accessing the 'explorer' attribute of any user instance
```python
user.explorere
user.explorer
```
Currently the explorer profile is used by the abstract model 'Submittable' and thus referenced by 'Place' and 'PlaceImage'. The explorer profile therefore has two attributes
```python
user.explorer.places
user.explorere.placeimages
user.explorer.placeimages
```
`places`
A list containing all (lost) places the user has submitted
@@ -36,12 +36,12 @@ TaggableManager, allows the sub class to be tagged, blank=True allows the admin
### Mapable
The abstract model Mapable represents an model that can be displayed on a map. It consists of tree members
`name`
Name of the object, displayed on the map, max length 50 characeter
Name of the object, displayed on the map, max length 50 characters
`latitude`
Latitude of the referenced location, -90 <= value <= 90
`longitude`
Longitude of the referenced location -180 <= value <= 180
A mapable model has to provide its own get_aboslute_url, in order to provide a link when clicked.
A mapable model has to provide its own get_absolute_url, in order to provide a link when clicked.
### Submittable
@@ -49,15 +49,15 @@ The abstract model Submittable represents an model that can be submitted by an u
`submitted_by`
Referencing the explorer profile, see [Explorer](##explorer-user-profile). If the explorer profile is deleted, this instance is kept (on_delete=models.SET_NULL). The related_name is set to the class name, lower case appending an s (%(class)s)
`submitted_when`
When the object was submitted, automaticly set by django (auto_now_add=True)
When the object was submitted, automatically set by django (auto_now_add=True)
### Voucher
A voucher code is needed to sign up using lostplaces sign up form. The model contains
`code`
The voucher code, max length 30 character
The voucher code, max length 30 characters
`created_when`
When the voucher was created automaticly set by django (auto_now_add=True)
When the voucher was created automatically set by django (auto_now_add=True)
`expires_when`
Till what date the voucher remains valid
@@ -65,7 +65,7 @@ Till what date the voucher remains valid
### Place
The place model is the heart of this project. It stores all information about a place needed.
`location`
Human readable location description (town, village, street), max length 50 character
Human readable location description (town, village, street), max length 50 characters
`description`
Describing the place in detail
The place model uses these abstract super classes