v1.0.8: Documentation links and API reference corrections#68
Merged
Conversation
…roject URL PyPI renders the README (long_description) at the project root, so repo-relative Markdown links like docs/plot_parity_policy.md resolve to https://pypi.org/project/ovvo-nns/docs/plot_parity_policy.md and 404. - Point all doc links at the live GitHub Pages site (https://ovvo-financial.github.io/NNS-python/<page>/), using the file-path-derived URLs that MkDocs actually emits. - Point example/source and LICENSE links at the GitHub repo on main. - Add a Documentation entry to [project.urls] so PyPI's sidebar links to the docs site, and drop the redundant Project URL. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JsqhFvg51XkvW4pCJquw42
The crosswalk and per-function "Closest R API" notes labeled the stochastic-dominance routines as FSD/SSD/TSD and the n-dimensional co-moments descriptively, which do not match the actual R NNS exports. Use the real exported names so the mapping is precise: - FSD/SSD/TSD -> NNS.FSD/NNS.SSD/NNS.TSD (and the .uni variants) - "N-dimensional ... path" -> Co.LPM_nD / Co.UPM_nD / DPM_nD - dy.d -> dy.d_ Applied to both docs/api_reference.md and the ApiMeta source in scripts/generate_api_reference.py that the page is generated from. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JsqhFvg51XkvW4pCJquw42
Bump the version consistently across pyproject.toml, nns.__version__, and the README "Current version" row (enforced by scripts/check_version_consistency.py). Provenance in sync/nns_source.json already records the R + NNS-core commits, so a v1.0.8 tag passes scripts/check_release_provenance.py. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JsqhFvg51XkvW4pCJquw42
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
2 participants
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.
Summary
This release updates documentation links throughout the project to point to the hosted documentation site, corrects API reference mappings for R equivalents, and bumps the version to 1.0.8.
Key Changes
Version bump: Updated version from 1.0.7 to 1.0.8 in
pyproject.tomlandsrc/nns/__init__.pyDocumentation link migration: Converted relative local documentation links in README.md to absolute URLs pointing to the hosted documentation site at
https://ovvo-financial.github.io/NNS-python/:docs/plot_parity_policy.md→ hosted plot parity policy pagedocs/api_status.md→ hosted API status pagedocs/conventions.md→ hosted conventions pagedocs/api_reference.md→ hosted API reference pagedocs/parity.md→ hosted parity pagedocs/benchmarks.md→ hosted benchmarks pageAPI reference corrections: Fixed R API equivalent mappings in
docs/api_reference.mdandscripts/generate_api_reference.py:co_lpm_nd: "N-dimensional co-LPM path" →Co.LPM_nDco_upm_nd: "N-dimensional co-UPM path" →Co.UPM_nDdpm_nd: "N-dimensional DPM path" →DPM_nDfsd,ssd,tsd: AddedNNS.namespace prefixfsd_uni,ssd_uni,tsd_uni: AddedNNS.namespace prefixdy_d:dy.d→dy.d_(corrected underscore suffix)Project metadata: Updated
pyproject.tomlURLs to include Documentation link and reorder URL entriesImplementation Details
The changes ensure that:
https://claude.ai/code/session_01JsqhFvg51XkvW4pCJquw42