Repository navigation
docs: fix Sphinx warnings and resolve cross-references - #177
Merged
Merged
Conversation
bundle-adjust.rst re-documented ViewPoint, Landmark and Observation, which the support-classes autosummary already generates, giving 75 duplicate object description warnings. Mark the manual copies no-index. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
- ImageConstants: blank line after |dtype_aliases| so the following :param field is not a block-quote error (9 docstrings) - ImageSpatial: point Kernel references at machinevisiontoolbox.Kernel.Kernel, removing an ambiguous cross-reference - iwrite: the example had collapsed onto two lines; restore it - mpl_styling: pseudo-code block is not valid Python, mark it text - intro.rst: separate the camera example code from its printed output Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Types such as ndarray(N,2), "2-tuple" or "Vertex subclass" are split into words and treated as class names. Ignore these pseudo-types by pattern, cutting nitpicky warnings from 2079 to 712 and leaving the genuinely unresolved references visible. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
- conf.py: resolve bare toolbox names (Image, PointCloud, ...) under machinevisiontoolbox; add the Python intersphinx inventory; ignore pgraph-relative names, OpenCV names and NumPy private typing aliases - Camera, ImagePointFeatures: correct matplotlib references (patches.Circle, axes.Axes, lines.Line2D, Axes3D) Nitpicky warnings: 712 to 357. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…links - conf.py: resolve bare spatialmath names (SE3, Polygon2, ...) through the smtb inventory and PointCloud names under machinevisiontoolbox.PointCloud; ignore the undocumented CameraBase, the Dtype alias and shape names like 2N - sources.rst, Kernel.py: link Image as machinevisiontoolbox.Image, and remove a stray line of repeated Image links from the Kernel docstring - BaseFeature2D.table: plain ``str`` instead of a broken :meth: reference Nitpicky warnings: 357 to 265. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 7 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
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.
Cuts the normal docs build from 100 warnings to 1, and a nitpicky (
-n) build from 2,317 to 265.:no-index:(75 warnings).|dtype_aliases|, theiwriteexample, thempl_stylingpseudo-code and theintro.rstcamera example.conf.pyfor bare toolbox and spatialmath names, the Python intersphinx inventory, and pattern ignores for shape annotations, pgraph-relative names, OpenCV and NumPy private typing aliases.The one remaining normal warning is a macOS-only clash between
Image.tensorandImage.Tensorstub names. About 170 nitpicky targets remain, each a single-docstring typo, left for follow-up. Docstring and docs changes only; the test suite passes.🤖 Generated with Claude Code