-
Notifications
You must be signed in to change notification settings - Fork 63
Cleanup docs #1913
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
Cleanup docs #1913
Conversation
zacharyburnett
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some suggestions
nden
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me.
Question about the developer docs - are they still valid/necessary or obsolete? Should they be moved somewhere else?
Co-authored-by: Zach Burnett <[email protected]>
Co-authored-by: Zach Burnett <[email protected]>
Co-authored-by: Zach Burnett <[email protected]>
Thanks! That document is largely out-dated. Reading through it recently it contains:
I'm in favor of removing this document and not updating or replacing it. If there are gaps in the private documentation adding docstring and comments to the non-obvious code seems like an approach that would be more likely to be maintained with future code updates. |
|
@nden I went ahead and merged this. If updating/restoring or an alternative for the removed developer docs is wanted I can open a follow-up PR. |
Description
Closes #1893
Updates docs from review.
Some changes of note are:
memmap=Truewas describedFractionWithInverseconverter exampleTasks
pre-commiton your machinepyteston your machineno-changelog-entry-needed)changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see below for change types)docs/pagenews fragment change types...
changes/<PR#>.feature.rst: new featurechanges/<PR#>.bugfix.rst: bug fixchanges/<PR#>.doc.rst: documentation changechanges/<PR#>.removal.rst: deprecation or removal of public APIchanges/<PR#>.general.rst: infrastructure or miscellaneous change