Removed some help_* methods #133
Merged
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
I originally created separate help_* methods for various built-in do_* methods so that: - The Sphinx docs could use the do_* docstring which could have extra reStructuredText markup embedded - The built-in help command could use the text from the help_* method This seemed like a good idea at the time, but I changed my mind - I was actually adding a maintenance headache. - And the payoff was small So I have now switched to using the do_* docstring for both the built-in help and Sphinx documentation. - With some very minor usage of reStructuredText markup that doesn't look bad when displaying built-in help
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.
I originally created separate help_* methods for various built-in do_* methods so that:
This seemed like a good idea at the time, but I changed my mind - I was actually adding a maintenance headache.
So I have now switched to using the do_* docstring for both the built-in help and Sphinx documentation.
This closes #132