Doc streamline #875
Merged
Doc streamline #875
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
- In docs/api/cmd.rst, the `cmd2.Cmd` class was defined as `cmd2.cmd2.Cmd`, which required the extraneous `cmd2` every time we referenced it. This extra `cmd2` is no longer required. - always refer to a bare cmd2 using ``cmd2`` per our documentation conventions
# Conflicts: # docs/features/settings.rst
# Conflicts: # docs/features/settings.rst
…into doc_streamline # Conflicts: # docs/features/settings.rst
Codecov Report
@@ Coverage Diff @@
## master #875 +/- ##
==========================================
+ Coverage 97.37% 97.39% +0.01%
==========================================
Files 14 14
Lines 3580 3602 +22
==========================================
+ Hits 3486 3508 +22
Misses 94 94
Continue to review full report at Codecov.
|
tleonhardt
approved these changes
Feb 7, 2020
| @@ -1,9 +1,11 @@ | |||
| cmd2.Cmd | |||
| ======== | |||
|
|
|||
| .. autoclass:: cmd2.cmd2.Cmd | |||
| .. autoclass:: cmd2.Cmd | |||
There was a problem hiding this comment.
Not having to type cmd2.cmd2 everywhere is so much nicer. Thanks!
| Python built-in print function. | ||
|
|
||
| 2. Reference the full dotted path to the method, but only display the method | ||
| name:: | ||
|
|
||
| The :meth:`~cmd2.cmd2.Cmd.poutput` method is similar to the Python built-in print function. | ||
| The :meth:`~cmd2.Cmd.poutput` method is similar to the Python built-in print function. |
There was a problem hiding this comment.
I'm just curious, what does starting with a ~ do when using :meth:? Sometimes I see the tilde and others I don't.
| @@ -149,7 +149,7 @@ single or double quotes):: | |||
| (Cmd) | |||
|
|
|||
| Automating cmd2 apps from other CLI/CLU tools | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
There was a problem hiding this comment.
Is there a reason you are extending past the text above? (applies to next file below too)
|
I'm going to merge this since it looks good. |
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.
It used to be that to reference code in the documentation you had to do something like:
which just looks ugly. I fixed that so you can do:
Progress for #765