loader, module: Fix help_prefix cleanup & example docs #1303
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
Callable cleanup in loader now always uses help_prefix's default value to replace. The documentation for module.example() reflects this, and I also moved the constructor documentation up to where it would be included in the auto-generated API docs (so the parameters are now visible in the public documentation without reading the code).
|
Merging this will let me clean up my branch that addresses #1200. It's the oldest "ready-to-go" PR at present, and I do prefer merging in FIFO order when possible. |
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.
Callable cleanup in loader now always uses help_prefix's default value to replace. The documentation for module.example() reflects this, and I also moved the constructor documentation up to where it would be included in the auto-generated API docs (so the parameters are now visible in the public documentation without reading the code).
This should resolve #1283. I might add sanity checking for
help_prefix(e.g. checking its length and printing a warning on startup if it's longer than one character), based on feedback from @kwaaak.