Skip to content

Add cross-reference notes between CLI and Python API documentation#791

Merged
simonw merged 1 commit into
mainfrom
claude/cli-python-doc-links-8vzo1c
Jul 12, 2026
Merged

Add cross-reference notes between CLI and Python API documentation#791
simonw merged 1 commit into
mainfrom
claude/cli-python-doc-links-8vzo1c

Conversation

@simonw

@simonw simonw commented Jul 12, 2026

Copy link
Copy Markdown
Owner

Take a look at the CLI documentation, and how it occasionally linked to the corresponding python feature - review if there are opportunities to add more links like that, and also to add reverse links back from Python to CLI

The CLI documentation had a handful of sections with notes linking to the
equivalent Python API feature. Extend that pattern to every CLI section
with a Python equivalent, and add matching 'In the CLI:' notes to the
Python API documentation linking back to the corresponding CLI command.

Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01WrZcTpmBvCq1HqPDweDjVT


📚 Documentation preview 📚: https://sqlite-utils--791.org.readthedocs.build/en/791/

The CLI documentation had a handful of sections with notes linking to the
equivalent Python API feature. Extend that pattern to every CLI section
with a Python equivalent, and add matching 'In the CLI:' notes to the
Python API documentation linking back to the corresponding CLI command.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WrZcTpmBvCq1HqPDweDjVT
@codecov

codecov Bot commented Jul 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.55%. Comparing base (5e8822e) to head (f2b455e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #791   +/-   ##
=======================================
  Coverage   95.55%   95.55%           
=======================================
  Files           9        9           
  Lines        3798     3798           
=======================================
  Hits         3629     3629           
  Misses        169      169           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@simonw simonw merged commit 3f04717 into main Jul 12, 2026
107 checks passed
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