You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I want my Python files to be well-structured and -commented,
so that my code is easy to audit and maintain
Acceptance Criteria
All self-written Python files in the project have classes and methods with appropriate docstrings
All self-written Python files in the project have inline comments explaining areas that require particular attention or have proven to be common stumbling blocks
All self-written Python files in the project are organized into logical and well-commented blocks
All self-written Python files in the project have commented-out code removed
Comment coverage errs on the side of "more is more", as befits a neurodivergent coder's first-time Django ReST Framework project.
Files
api-task-manager/
permissions.py
serializers.py
settings.py
urls.py
views.py
comments/
admin.py
models.py
serializers.py
tests.py
urls.py
views.py
profiles/
admin.py
models.py
serializers.py
urls.py
views.py
tasks/
admin.py
models.py
serializers.py
urls.py
views.py
watchers/
admin.py
models.py
serializers.py
urls.py
views.py
The text was updated successfully, but these errors were encountered:
As a Developer,
I want my Python files to be well-structured and -commented,
so that my code is easy to audit and maintain
Acceptance Criteria
Files
api-task-manager/
permissions.py
serializers.py
settings.py
urls.py
views.py
comments/
admin.py
models.py
serializers.py
tests.py
urls.py
views.py
profiles/
admin.py
models.py
serializers.py
urls.py
views.py
tasks/
admin.py
models.py
serializers.py
urls.py
views.py
watchers/
admin.py
models.py
serializers.py
urls.py
views.py
The text was updated successfully, but these errors were encountered: