docs: add detailed docstrings to model mixin properties

[mayankjndl]

Closes #2648

Adds clear and consistent docstrings to all index-related mixin properties in:

• RepositoryIndexMixin
• UserIndexMixin
• ProjectIndexMixin

This change improves documentation and developer understanding of what each indexed property returns and how it is used by the search/indexing layer.

No application logic was changed - documentation only.

---

• I followed the contributing workflow
• I verified that my changes are documentation-only and correct
• I ran make check-test locally (not required for doc-only changes)
• I used AI for this PR

[coderabbitai]

Summary by CodeRabbit

• Chores
  • Expanded documentation across repository, user, and project indexing properties with improved descriptions and technical details.
  • Refined repository indexing constraints to require proper association with active projects.
  • Updated user indexing logic with additional exclusion criteria for enhanced consistency.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Three model mixin files receive comprehensive docstring updates across property methods. Additionally, is_indexable logic in repository and user mixins is refined to include stricter validation constraints for indexability determination.

Changes

Cohort / File(s)	Summary
GitHub Mixin Logic & Docstring Updates backend/apps/github/models/mixins/repository.py, backend/apps/github/models/mixins/user.py	is_indexable enhanced with additional validation: repository.py adds template status and project association checks; user.py adds non-indexable_logins exclusion check. Extensive docstring additions across idx_* properties in both files documenting return types, purposes, and indexing implications.
OWASP Mixin Docstring Expansion backend/apps/owasp/models/mixins/project.py	Comprehensive docstring additions to indexing properties describing purpose, return values, and behavior. No functional logic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	❓ Inconclusive	One concern exists: the repository.py and user.py files contain logic changes to is_indexable beyond docstring additions, which may exceed the documentation-only scope claimed in the PR description.	Clarify whether the is_indexable logic changes (project_set.exists() and non_indexable_logins) are intentional scope additions or should be separated into a different PR.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding detailed docstrings to model mixin properties across the three specified files.
Description check	✅ Passed	The description clearly explains the purpose of the PR, references the linked issue #2648, lists the affected files, and confirms that only documentation was changed.
Linked Issues check	✅ Passed	The PR successfully addresses issue #2648 by adding docstrings to all property methods in the three specified mixin files (RepositoryIndexMixin, UserIndexMixin, ProjectIndexMixin).
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[arkid15r]

Closing in favor of #3532
Please request to be assigned to more issues, your work is good.

[mayankjndl]

Thanks @arkid15r, really appreciate the feedback. I’ll make sure to request assignment on more issues and keep contributing.