Cleanup docs#1913
Conversation
nden
left a comment
There was a problem hiding this comment.
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 <zachary.r.burnett@gmail.com>
Co-authored-by: Zach Burnett <zachary.r.burnett@gmail.com>
Co-authored-by: Zach Burnett <zachary.r.burnett@gmail.com>
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