Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstrings to Octopoes models #4038

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stephanie0x00
Copy link
Contributor

Changes

This PR adds docstrings to extend the Octopoes model.

Issue link

Issue: #2946

Closes #2946

Demo

Please add some proof in the form of screenshots or screen recordings to show (off) new functionality, if there are interesting new features for end-users.

QA notes

Please add some information for QA on how to test the newly created code.


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@stephanie0x00 stephanie0x00 requested a review from a team as a code owner January 21, 2025 12:01
@stephanie0x00 stephanie0x00 marked this pull request as draft January 21, 2025 12:01
Comment on lines +15 to +17
Functions:
natural_keys: returns property of the class.
format_reference_human_readable: returns the title text for objects on the object details page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two things:

  • This isn't necessary to document here. If we want to document them, then this should be placed in the base OOI class
  • Replace (also in the other changes) "Returns" with "Represents"
Suggested change
Functions:
natural_keys: returns property of the class.
format_reference_human_readable: returns the title text for objects on the object details page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend Octopoes documentation with object definitions
2 participants