pytest-dev / pytest-dev/pytest-xdist

autofunction:: xdist.is_xdist_master generates incorrect description

Open
#1,159 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
287
Avg merge
9h 30m
Merged PRs (30d)
2

Description

On the https://pytest-xdist.readthedocs.io/en/stable/how-to.html#xdist.is_xdist_master url, for me the description is:
Return True if this is the xdist controller, False otherwise.
image

Based on the original ticket: https://github.com/pytest-dev/pytest-xdist/issues/504
It should be:
Return True if this is the xdist master, False otherwise.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the xdist.is_xdist_master entry in the how-to.html documentation page and compare its generated description with the wording from pytest-xdist issue #504. Done means the description says, "Return True if this is the xdist master, False otherwise."

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.