docs: resolve warnings - #849
Open
mcepl wants to merge 3 commits into
Open
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #849 +/- ##
=======================================
Coverage 95.24% 95.24%
=======================================
Files 134 134
Lines 26292 26292
=======================================
Hits 25043 25043
Misses 1249 1249 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR aims to eliminate Sphinx documentation build warnings and tidy up related quality-of-life issues across the repo, including doc rendering tweaks and small type-checking/formatting cleanups.
Changes:
- Adjust documentation sources to avoid Sphinx/docutils warnings (fix a title underline; switch certain example blocks to non-highlighted code blocks; add a global Sphinx warning suppression).
- Normalize
# type: ignorecomment formatting across several modules. - Update GitHub Actions workflow dependencies (checkout/setup-python/codecov) to newer major versions.
Reviewed changes
Copilot reviewed 8 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| rope/refactor/move.py | Normalizes # type: ignore formatting for mypy-related comments. |
| rope/contrib/autoimport/sqlite.py | Removes a stray whitespace-only line. |
| rope/base/project.py | Normalizes # type: ignore formatting on imports. |
| rope/base/oi/type_hinting/providers/numpydocstrings.py | Normalizes # type: ignore formatting around optional numpydoc import. |
| rope/base/oi/type_hinting/evaluate.py | Normalizes # type: ignore formatting on decorators and definitions. |
| rope/base/oi/runmod.py | Normalizes # type: ignore formatting around cPickle import fallback. |
| rope/base/oi/doa.py | Normalizes # type: ignore formatting around cPickle/pickle imports. |
| rope/base/fscommands.py | Normalizes # type: ignore formatting for optional VCS-related imports. |
| rope/base/ast.py | Normalizes # type: ignore formatting around stdlib-private import. |
| docs/overview.rst | Changes specific example blocks to code-block:: none to avoid highlighting failures due to placeholder tokens. |
| docs/configuration.rst | Fixes section title underline length to satisfy docutils. |
| docs/conf.py | Adds global Sphinx suppress_warnings configuration for docutils warnings. |
| .github/workflows/python-publish.yml | Updates checkout/setup-python action major versions. |
| .github/workflows/main.yml | Updates checkout/setup-python/codecov action major versions. |
| .github/workflows/codeql.yml | Updates checkout action major version. |
| .github/workflows/black.yml | Updates checkout action major version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+69
to
+71
|
|
||
| # suppress third-party generated warnings | ||
| suppress_warnings = ["docutils"] |
Comment on lines
+16
to
20
| - uses: actions/checkout@v7 | ||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v5 | ||
| uses: actions/setup-python@v7 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} |
This file contains hidden or 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
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.
Fixes these warnings: