Skip to content

Goodpractises docs reorganization/review #1212

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

Merged
merged 13 commits into from
Dec 5, 2015

Conversation

nicoddemus
Copy link
Member

Fixed #1134 and took opportunity to review and reorganize goodpractises a little.

  • Moved "Conventions for Python test discovery" and "Choosing test layout" to the top
  • Moved deprecated genscript method to the bottom and added a .. deprecated: directive;
  • Removed detailed session about setuptools and genscript integration, since the latter is deprecated anyway;
  • Merged tox and virtualenv sessions: Nowadays virtualenv's usage is pretty standard so we don't need to devote a how-to section in pytest's docs


Add this to ``setup.py`` file::
.. code-block:: python

Copy link
Member

Choose a reason for hiding this comment

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

We should additionally get rid of distutils refs while we are at it

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!


scripts/activate # on Windows
* collection starts from paths specified in :confval:`testpaths` if configured,
otherwise from initial command line arguments which may be directories,
Copy link
Contributor

Choose a reason for hiding this comment

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

that's ambiguous. https://pytest.org/latest/customize.html#confval-testpaths is more precise in saying that if you are specifying command line args "testpaths" is not considered.

@hpk42
Copy link
Contributor

hpk42 commented Dec 2, 2015

apart from the two minor comments i am fine with merging this.

@RonnyPfannschmidt
Copy link
Member

well done

do we have the issue references of all those that are solved by this one, i think its a actual bunch

@nicoddemus
Copy link
Member Author

@hpk42 thanks for the comments, I will apply them and then we can merge.

@RonnyPfannschmidt they are all referenced in the commit messages so the issues should be closed when we merge this, but I'll make sure they are.

@nicoddemus
Copy link
Member Author

Applied requested changes.

@hpk42 please review the new wording... feel free to suggest something better as well. 😄

@RonnyPfannschmidt
Copy link
Member

Well done

@hpk42 I think it s ready for merge

nicoddemus added a commit that referenced this pull request Dec 5, 2015
Goodpractises docs reorganization/review
@nicoddemus nicoddemus merged commit 41f1979 into pytest-dev:master Dec 5, 2015
@nicoddemus nicoddemus deleted the goodpractices branch December 5, 2015 02:27
@RonnyPfannschmidt
Copy link
Member

👍

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.

4 participants