Lots of small documentation improvements #1375
Merged
Conversation
This file contains 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
The suggested citation will be updated again if or when we publish in e.g. JOSS
Even if we don't use them, it's useful to have a standard suggestion for anyone who does want a badge.
Including of pytest.mark.hypothesis
alexwlchan
reviewed
Jul 1, 2018
hypothesis-python/docs/community.rst
Outdated
| <https://github.com/HypothesisWorks/hypothesis/blob/master/CITATION>`_. | ||
|
|
||
| If you like repo badges, we suggest the following badge, which you can add | ||
| with restructuredtext or markdown, respectively: |
There was a problem hiding this comment.
nit: “reStructuredText or Markdown” is the correct capitalisation
hypothesis-python/docs/community.rst
Outdated
|
|
||
| .. code:: md | ||
|
|
||
| [](https://hypothesis.readthedocs.io/) |
There was a problem hiding this comment.
minor: maybe include some alt text in the image? “Tested with Hypothesis”?
hypothesis-python/docs/stateful.rst
Outdated
| @@ -179,6 +179,10 @@ on a function. | |||
| Note that RuleBasedStateMachine must have at least one rule defined and that | |||
| a single function cannot be used to define multiple rules (this to avoid having | |||
| multiple rules doing the same things). | |||
| Due to the stateful execution method, rules are generally cannot take arguments | |||
There was a problem hiding this comment.
“rules are generally” – do you need the “are”?
alexwlchan
approved these changes
Jul 2, 2018
hypothesis-python/docs/details.rst
Outdated
| .. _pytest-plugin: | ||
|
|
||
| ---------------------------- | ||
| The Hypothesis Pytest Plugin |
There was a problem hiding this comment.
nit: the style convention in the pytest docs is to use a lowercase “p”
e.g. https://docs.pytest.org/en/latest/existingtestsuite.html
hypothesis-python/docs/details.rst
Outdated
| Hypothesis includes a tiny plugin to improve integration with :pypi:`pytest`, | ||
| which is activated by default (but does not affect other test runners). | ||
| It aims to improve the integration between Hypothesis and Pytest by | ||
| providing extra information and a convenient access to config options. |
There was a problem hiding this comment.
nit: is the “a” needed? Feels a bit jarring to me – “and convenient access to config options” scans more naturally.
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.
@composite- including explicit comparison tost.data().@ruleand@pytest.mark.parametrizedo not work well together.