Skip to content

Add a new Exceptions section in documentation and document UsageError - #5231

Merged
nicoddemus merged 1 commit into
pytest-dev:masterfrom
Pulkit07:issue4560
Jun 3, 2019
Merged

Add a new Exceptions section in documentation and document UsageError#5231
nicoddemus merged 1 commit into
pytest-dev:masterfrom
Pulkit07:issue4560

Conversation

@Pulkit07

@Pulkit07 Pulkit07 commented May 8, 2019

Copy link
Copy Markdown
Contributor

This PR fixes #4560

  • Create a new changelog file in the changelog folder, with a name like <ISSUE NUMBER>.<TYPE>.rst. See changelog/README.rst for details.
  • Target the master branch for bug fixes, documentation updates and trivial changes.
  • Target the features branch for new features and removals/deprecations.
  • Include documentation when adding new features.
  • Include new tests or update existing tests when applicable.

Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:

  • Add yourself to AUTHORS in alphabetical order;

@codecov

codecov Bot commented May 8, 2019

Copy link
Copy Markdown

Codecov Report

Merging #5231 into master will decrease coverage by 1.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5231      +/-   ##
==========================================
- Coverage   93.33%   92.26%   -1.08%     
==========================================
  Files         114      115       +1     
  Lines       25493    26159     +666     
  Branches     2480     2578      +98     
==========================================
+ Hits        23795    24135     +340     
- Misses       1379     1702     +323     
- Partials      319      322       +3
Impacted Files Coverage Δ
testing/test_reports.py 10.49% <0%> (-89.51%) ⬇️
testing/test_resultlog.py 53.6% <0%> (-46.4%) ⬇️
testing/test_runner.py 59.65% <0%> (-36.62%) ⬇️
testing/python/collect.py 74.2% <0%> (-25.17%) ⬇️
src/_pytest/reports.py 71.42% <0%> (-23.63%) ⬇️
src/_pytest/resultlog.py 67.14% <0%> (-19.43%) ⬇️
testing/test_argcomplete.py 68.11% <0%> (-13.37%) ⬇️
testing/python/fixtures.py 83.96% <0%> (-6.61%) ⬇️
testing/python/integration.py 91.42% <0%> (-2.15%) ⬇️
src/_pytest/assertion/__init__.py 86.76% <0%> (-1.95%) ⬇️
... and 90 more

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 3a8b082...1d6bbab. Read the comment docs.

@nicoddemus
nicoddemus changed the base branch from features to master May 14, 2019 21:36

@nicoddemus nicoddemus left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Pulkit07!

Small tip: If you write "Fix #(num)" in the body of the PR or commit, it will automatically close the related issue when it gets merged. See:

https://help.github.com/en/articles/closing-issues-using-keywords

I've updated the description to use "Fix #(num)".

Also, I just realized that this should target master, as is a small docs update. I've updated the base branch myself.

@nicoddemus

Copy link
Copy Markdown
Member

Merging as docs passed already. Thanks @Pulkit07 again for the PR. 👍

@nicoddemus
nicoddemus merged commit f223d26 into pytest-dev:master Jun 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document UsageError

2 participants