Skip to content

Add Docstrings to Sitemap View Methods #2645

@coderabbitai

Description

@coderabbitai

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 entries
  • location() - Explain URL location generation for sitemap entries
  • items() - Explain queryset/items returned for sitemap generation
  • lastmod() - Explain last modification timestamp logic
  • priority() - 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-test locally before submitting

Estimated Effort

2 story points

Related

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions