docs: remove extra characters in the command line prompt #5153
Conversation
hroncok
added
the
type: docs
|
I've used the GitHub web Interface to create this PR. Please squash when merging. Note that I think those characters there are redundant, but I'm not sure if the bare no special meaning. |
Codecov Report
@@ Coverage Diff @@
## master #5153 +/- ##
==========================================
+ Coverage 95.79% 96.06% +0.27%
==========================================
Files 114 114
Lines 25825 25825
Branches 2550 2550
==========================================
+ Hits 24740 24810 +70
+ Misses 757 705 -52
+ Partials 328 310 -18
Continue to review full report at Codecov.
|
Not possible (#4361). I think those examples should be auto-generated, see |
| @@ -0,0 +1,2 @@ | |||
| Remove extra characters in the shown command line prompts in the test discovery | |||
| documentation. | |||
There was a problem hiding this comment.
btw: I do not think we need a changelog for this.
There was a problem hiding this comment.
me neither. creating this was pain via github.
There was a problem hiding this comment.
https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst
trivial: fixing a small typo or internal change that might be noteworthy.
Note sure if the "might be noteworthy" part applies to fixing typos, but I think this list should be updated to say not to create this just for a trivial typo fix.
There was a problem hiding this comment.
Oh excellent point, thanks for pointing that out! We should update that templates to mean that trivial is meant to actual code or dependency changes, but not to small documentation changes in general. 👍
blueyed
changed the title
Probably means that they are currently not updated then, and that this PR is good to do so in the future. |
| @@ -206,7 +206,7 @@ You can always peek at the collection tree without running tests like this: | |||
|
|
|||
| .. code-block:: pytest | |||
|
|
|||
| . $ pytest --collect-only pythoncollection.py | |||
There was a problem hiding this comment.
They are there to not run regendoc, because regendoc uses the line starting as $ to mean to execute the shell command:
There was a problem hiding this comment.
So this PR is probably bogus. Should I open an issue to have a mechanism for this that doesn't uglify the docs?
There was a problem hiding this comment.
Good idea, I would kindly ask to create it in https://github.com/pytest-dev/regendoc though. 👍
There was a problem hiding this comment.
Note that studying the code, a dot with a space should not stop regendoc:
There was a problem hiding this comment.
They are there to not run regendoc
Why though? Shouldn't we have working examples for those also?
There was a problem hiding this comment.
You are right, probably they should
Yep, missed your comment before commenting earlier. Thanks a lot for the quick and thoughtful contribution @hroncok, but I guess we can close this. 👍 |
Thanks for submitting a PR, your contribution is really appreciated!
Here's a quick checklist that should be present in PRs (you can delete this text from the final description, this is
just a guideline):
changelogfolder, with a name like<ISSUE NUMBER>.<TYPE>.rst. See changelog/README.rst for details.masterbranch for bug fixes, documentation updates and trivial changes.