-
-
Notifications
You must be signed in to change notification settings - Fork 287
Open
Labels
Description
Description
Multiple methods in sitemap views lack docstrings. Adding these will improve code clarity and help developers understand the purpose and return values of each method.
Files to Update
backend/apps/sitemap/views/ - All view files:
- base.py
- chapter.py
- committee.py
- member.py
- organization.py
- project.py
- repository.py
- snapshot.py
- static.py
Methods Requiring Docstrings
The following methods need concise docstrings where missing:
changefreq()- Explain change frequency setting for sitemap entrieslocation()- Explain URL location generation for sitemap entriesitems()- Explain queryset/items returned for sitemap generationlastmod()- Explain last modification timestamp logicpriority()- Explain priority value for sitemap entries
Note: Some files like base.py already have good docstring examples. Use these as a reference for consistency.
Acceptance Criteria
- Add docstrings to all instances of the above methods across sitemap view files where missing
- Docstrings should clearly explain what each method does
- Docstrings should specify return types
- Follow existing docstring style/format in the codebase (see base.py for examples)
- Run
make check-testlocally before submitting
Estimated Effort
2 story points
Related
- Parent issue: Good First Issues: 10 Beginner-Friendly Tasks for Backend & Frontend #2628
- Requested by: @arkid15r
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Todo