Skip to content
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.

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

doc(plugin_hooks): Improve documentation for writing plugin hooks. #5517

Merged
merged 2 commits into from Jun 29, 2019

Conversation

Projects
None yet
2 participants
@NiklasMM
Copy link
Contributor

commented Jun 28, 2019

I wrote my first plugin hooks today and since I found the documentation somewhat lacking, I extended it somewhat, so other people will have an easier time. :)

Would be great if someone with a better understanding of the subject could double check if I didn't make any mistakes.

@NiklasMM NiklasMM force-pushed the NiklasMM:doc/improve-custom-hooks-doc branch from 9d8dfab to 8411394 Jun 28, 2019

@nicoddemus
Copy link
Member

left a comment

@NiklasMM thanks a lot for the contribution!

I think the documentation is a good start, please see my comments for suggestions on how to improve it. 👍

Show resolved Hide resolved doc/en/writing_plugins.rst Outdated
Show resolved Hide resolved doc/en/writing_plugins.rst Outdated
Show resolved Hide resolved doc/en/writing_plugins.rst Outdated
Show resolved Hide resolved doc/en/writing_plugins.rst Outdated
Show resolved Hide resolved doc/en/writing_plugins.rst Outdated

@NiklasMM NiklasMM force-pushed the NiklasMM:doc/improve-custom-hooks-doc branch from 8411394 to 93a68cd Jun 29, 2019

@codecov

This comment has been minimized.

Copy link

commented Jun 29, 2019

Codecov Report

Merging #5517 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5517   +/-   ##
=======================================
  Coverage   96.11%   96.11%           
=======================================
  Files         117      117           
  Lines       25695    25695           
  Branches     2493     2493           
=======================================
  Hits        24696    24696           
  Misses        695      695           
  Partials      304      304

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 4bc0415...789a366. Read the comment docs.

@NiklasMM

This comment has been minimized.

Copy link
Contributor Author

commented Jun 29, 2019

Thanks @nicoddemus, I tried to implement all of your suggestions.

@nicoddemus
Copy link
Member

left a comment

Awesome, thanks!

@nicoddemus

This comment has been minimized.

Copy link
Member

commented Jun 29, 2019

Linting failed, to fix it one can use tox -e linting. I've just did it myself and pushed. Thanks!

@nicoddemus nicoddemus merged commit d4a76a0 into pytest-dev:master Jun 29, 2019

5 checks passed

WIP Ready for review
Details
codecov/patch Coverage not affected when comparing 4bc0415...789a366
Details
codecov/project 96.11% remains the same compared to 4bc0415
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
pytest-CI #20190629.8 succeeded
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.