WIP: Update models docstrings to follow proper RST conventions#583
Draft
ormsbee wants to merge 2 commits intoopenedx:mainfrom
Draft
WIP: Update models docstrings to follow proper RST conventions#583ormsbee wants to merge 2 commits intoopenedx:mainfrom
ormsbee wants to merge 2 commits intoopenedx:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This reformats a lot of our docstrings to follow RST practices properly, like real links to classes and models, fixing some Markdown-isms, reformatting broken definition lists, etc. The thing that makes me twitch the most is reformatting large block-comments over variable declarations to be docstring-like comments under them.
There are still presentation issues that are really awkward:
I manually mucked around with the config a bit to see if I could get it looking better.
Also, I noticed while skimming the diff that a chunk of the docs are factually out-of-date, e.g. some of the Collection stuff. Fixing those things is beyond the scope of this PR.
To test locally, run
make docsat the root. You may need to install therequirements/doc.txtrequirements.The Claude prompt: