Improve autodoc of callables and variables #111
Merged
Conversation
This file contains 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
Currently our docs are useful, but lack visibility in some modules as to what components are provided by the code. This forces the reader to dive into source code. While code diving is a good thing, our docs should better describe what the module does. Types is the worst offender, but Localtime can also be improved. Also, we can make code diving easier. What this does: - Links autodocumented callables with their source code - Uses the autodata function to document variables in types and localtime
jamesbeith
approved these changes
Nov 1, 2023
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.
Currently our docs are useful, but lack visibility in some modules as to what components are provided by the code. This forces the reader to dive into source code. While code diving is a good thing, our docs should better describe what the module does. Types is the worst offender, but Localtime can also be improved.
Also, we can make code diving easier.
What this does: