minor doc improvements #2006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

gaborbernat merged 14 commits into rewrite from minor-doc-improvements

Apr 8, 2021

Member

jugmac00 commented Apr 8, 2021

@gaborbernat No need to review right now - I will go through the changes once more tonight. I am a bit in a hurry right now and the diff in the GitHub UI is actually better than the one on my local cli :-)

This was a quick reading through the docs - I will do a thorough proofreading again, maybe 2 weeks before a final release.


          minor doc improvements

a99a69b

jugmac00 requested a review from gaborbernat as a code owner

April 8, 2021 15:34

codecov bot commented Apr 8, 2021 •

edited

Loading

Codecov Report

Merging #2006 (5670a60) into rewrite (9608e23) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           rewrite    #2006   +/-   ##
========================================
  Coverage    99.83%   99.83%           
========================================
  Files          147      147           
  Lines         8286     8286           
  Branches       825      825           
========================================
  Hits          8272     8272           
  Misses           3        3           
  Partials        11       11

Flag	Coverage Δ
tests	`99.83% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/tox/plugin/spec.py	`100.00% <ø> (ø)`
src/tox/session/cmd/quickstart.py	`100.00% <ø> (ø)`
src/tox/session/cmd/run/common.py	`100.00% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9608e23...5670a60. Read the comment docs.

Member Author

jugmac00 commented Apr 8, 2021

I tried to use a towncrier file as suggested in the docs a la "something.trivial" but this was not permitted by pre-commit :-D

changelog filenames......................................................Failed
- hook id: changelogs-rst
- exit code: 1

changelog files must be named ####.(feature|bugfix|doc|removal|misc).rst

docs/changelog/minor.doc.improvements.trival

jugmac00 mentioned this pull request

tox4: suggested towncrier file "something.trivial" is not permitted by pre-commit check #2007

Closed

Member

gaborbernat commented Apr 8, 2021

changelog files must be named ####.(feature|bugfix|doc|removal|misc).rst

Update the documentation please per this rule.

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved

jugmac00 commented

View reviewed changes

docs/user_guide.rst Outdated Show resolved Hide resolved

jugmac00 commented

View reviewed changes

src/tox/plugin/spec.py Outdated Show resolved Hide resolved

jugmac00 added 3 commits

April 8, 2021 19:08


          Update docs/development.rst

31bcd0e


          Update docs/user_guide.rst

c9e6477


          Update src/tox/plugin/spec.py

84a9548

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

a7a29ac

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

20b51f6

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

58b06f7

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

a28e82b

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

d963a0a

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

4d52965

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

e2438ac

jugmac00 commented

View reviewed changes

docs/development.rst Outdated Show resolved Hide resolved


          Update docs/development.rst

c631992

jugmac00 commented

View reviewed changes

docs/user_guide.rst Outdated Show resolved Hide resolved


          Update docs/user_guide.rst

710990a


          add changelog entry

5670a60

psf-chronographer bot added the bot:chronographer:provided label

Member Author

jugmac00 commented Apr 8, 2021

@gaborbernat, should be ready to review!

gaborbernat approved these changes

View reviewed changes

gaborbernat merged commit 1a50180 into rewrite

gaborbernat deleted the minor-doc-improvements branch

April 8, 2021 22:35

jugmac00 added a commit that referenced this pull request


          Update documentation about changelog entries for trivial changes

c489d58

This fixes #2007

Part of the #2007 was already fixed by #2006, ie the paragraph about how
to create pseudo towncrier snippets was removed.

jugmac00 mentioned this pull request

Update documentation about changelog entries for trivial changes #2010

Merged

5 tasks

gaborbernat pushed a commit that referenced this pull request


          Update documentation about changelog entries for trivial changes (#2010)

7e4e22c

This fixes #2007

Part of the #2007 was already fixed by #2006, ie the paragraph about how
to create pseudo towncrier snippets was removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided