docs: fix stale/broken references and add footer build date - #57
Merged
Conversation
Not up to standards ⛔🔴 Issues
|
| Category | Results |
|---|---|
| ErrorProne | 1 high |
🟢 Metrics 0 complexity · 0 duplication
Metric Results Complexity 0 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.
rank() was deprecated in favour of rankfilter() (see ImageSpatial.py's DeprecationWarning), but the "Rank filter" entry on the algorithms overview page still pointed at the old name -- the only such stale reference anywhere in docs/source (checked every deprecated method/property name against every .rst file). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
decomposeF (fundamental-matrix decomposition) doesn't exist anywhere in the codebase, and can't meaningfully exist: unlike the essential matrix, a fundamental matrix alone can't be decomposed into a relative pose without the camera intrinsics -- that's exactly what decomposeE already handles, via the standard F -> E (using K) -> pose route. The mention was plain text (not a :meth: cross-reference, presumably because it would have been a broken link), the only trace of this in the entire repo. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Appends the Sphinx build date to the copyright string shown in every
page's footer (pydata-sphinx-theme renders it verbatim as
"© Copyright {{ copyright }}."), computed dynamically via
datetime.date.today() so it tracks whenever the docs are actually
built rather than needing a manual update.
Also switched the year range from the ambiguous trailing "2020-," to
"2020-present," -- the bare trailing hyphen immediately followed by a
comma read as stacked punctuation rather than an intentional
open-ended range.
Verified with a real sphinx-build (full docs extra installed into an
isolated venv): renders as
"© Copyright 2020-present, Peter Corke: built 2026-08-03." in the
built footer, no new warnings introduced.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
petercorke
force-pushed
the
docs/misc-doc-fixes
branch
from
August 3, 2026 10:57
a44caa3 to
e7de5bf
Compare
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
1 participant
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.
(Re-opened as a new PR -- #55 was accidentally closed without merging, and GitHub wouldn't allow reopening it after an earlier branch rename left it referencing a now-nonexistent old branch name. Same branch, same 3 commits, nothing lost.)
Summary
Test plan