Skip to content

Conversation

@1ucian0
Copy link
Contributor

@1ucian0 1ucian0 commented Oct 19, 2025

Currently, tox -e doclint is always failing because of an issue introduced in doc8 1.1.2. The first report of this problem was made over a year ago, so I wouldn’t hold my breath for a fix soon.

I suggest capping the doc8<1.1.2 version until the upstream issue is resolved.

Version Information

Please provide:

  • The version of Python you're using: 3.11

  • The version of pip you used to install github3.py: 25.2

  • The version of github3.py, requests, uritemplate, and python-dateutil installed

    • github3.py: 4.0.1
    • requests: 2.32.5
    • uritemplate: 4.2.0
    • python-dateutil: 2.9.0.post0

Minimum Reproducible Example

tox -edoclint

Exception information

doclint: exit 1 (0.39 seconds) /Users/bel/code/github3.py> doc8 docs/source/ pid=28236
.pkg: _exit> python /Users/bel/code/github3.py/venv/lib/python3.11/site-packages/pyproject_api/_backend.py True hatchling.build
  doclint: FAIL code 1 (2.04=setup[1.65]+cmd[0.39] seconds)
  evaluation failed :( (2.06 seconds)

What is exceptional about what you're seeing versus what you expected to see.

When submitting a PR, CI should fail only (ideally) as a result of the changes introduced in that PR. Failures caused by dependency updates are not considered good practice.

@sigmavirus24 sigmavirus24 merged commit ad692fb into sigmavirus24:main Oct 20, 2025
12 checks passed
@1ucian0 1ucian0 deleted the tox/doclint/1 branch October 20, 2025 12:27
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.

2 participants