Clarify PYTHONPATH changes and ``rootdir`` roles by nicoddemus · Pull Request #2595 · pytest-dev/pytest

nicoddemus · 2017-07-20T00:17:31Z

Also minor adjustments in the docs (wording, formatting, links, etc).

coveralls · 2017-07-20T00:51:24Z

Coverage decreased (-0.0009%) to 92.122% when pulling 5ee55a0 on nicoddemus:docs-rootdir-pythonpath into c92760d on pytest-dev:master.

The-Compiler · 2017-07-21T09:19:15Z

+Here's a summary what ``pytest`` uses ``rootdir`` for:
+
+* Constructing ``nodeids`` during collection; each test is assigned
+  a unique ``nodeid`` which is rooted at the ``rootdir`` and takes in account full path,


nitpick: Why would nodeid and ini-file (both singular/plural) be monospaced? Those are "concepts", not variable names or code, right?

You are right, consistency is important (not nitpick at all IMHO) 😉

The-Compiler · 2017-07-21T09:19:37Z

 .. _examples:

-Usages and Examples
+Examples and customizations tricks


nitpick: customization (singular)

The-Compiler · 2017-07-21T09:20:59Z

+    root/
+    |- foo/
+       |- __init__.py
+       |- contest.py


contest -> conftest?

The-Compiler · 2017-07-21T09:21:04Z

+
+    root/
+    |- foo/
+       |- contest.py


contest -> conftest?

The-Compiler · 2017-07-21T09:24:34Z

Also cc @pfctdayelise @hackebrot who probably have some more experience with writing/reviewing documentation than I do.

- Also minor adjustments in the docs (wording, formatting, links, etc). Fix pytest-dev#2589

nicoddemus · 2017-07-21T10:31:19Z

Done all changes requested by @The-Compiler, thanks!

coveralls · 2017-07-21T10:57:10Z

Coverage decreased (-0.0009%) to 92.092% when pulling 3d24485 on nicoddemus:docs-rootdir-pythonpath into ccc4b3a on pytest-dev:master.

nicoddemus · 2017-07-24T12:15:18Z

@The-Compiler anything else you would like me to change? If not, could you update the status to approve? 😉

Gentle ping @hackebrot @pfctdayelise

The-Compiler · 2017-07-24T13:06:35Z

I think this is clearly an improvement over the status quo, so let's merge it 😉 Thanks!

nicoddemus · 2017-07-24T13:07:04Z

Thanks!

hackebrot · 2017-07-24T19:16:36Z

Hey @nicoddemus @The-Compiler! 👋

Sorry for the late response. I started my review right when you merged this PR. 😁 I'll submit a new PR with any changes that I was about to suggest, so we can discuss there. 👍

The-Compiler requested changes Jul 21, 2017

View reviewed changes

Clarify PYTHONPATH changes and rootdir roles

3d24485

- Also minor adjustments in the docs (wording, formatting, links, etc). Fix pytest-dev#2589

nicoddemus force-pushed the docs-rootdir-pythonpath branch from 5ee55a0 to 3d24485 Compare July 21, 2017 10:31

The-Compiler merged commit 81ad185 into pytest-dev:master Jul 24, 2017

nicoddemus deleted the docs-rootdir-pythonpath branch July 24, 2017 13:07

Uh oh!

Uh oh!

Conversation

nicoddemus commented Jul 20, 2017

Uh oh!

coveralls commented Jul 20, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

The-Compiler commented Jul 21, 2017

Uh oh!

nicoddemus commented Jul 21, 2017

Uh oh!

coveralls commented Jul 21, 2017

Uh oh!

nicoddemus commented Jul 24, 2017

Uh oh!

The-Compiler commented Jul 24, 2017

Uh oh!

nicoddemus commented Jul 24, 2017

Uh oh!

hackebrot commented Jul 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants