Repository navigation
DOC: trim docs, fix inaccuracies and rendering issues - #140
Merged
Merged
Conversation
- Keep "--" in option names (smartquotes turned them into en dashes, e.g. "–foreground" in the command line reference and search) - Let table cells, long inline code, titles and signatures wrap, so that tables are not clipped and no page needs horizontal scrolling, down to phone widths - Escape "[gh-actions](deps)" in the included changelog, which rendered as broken links to "#deps" (no longer suppressing the warning) - No "Edit on GitHub" links on generated pages (they 404ed); the contributing page links to CONTRIBUTING.md - API reference: no "(*values)" signature for FileState and no "Bases: object" lines Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TZnKRgtotR2MqJqkzJfvRU
Trim (~200 lines) content duplicated across pages or of little value: clone/unmount output and repeated caching details in the tutorial, the Jupyter pattern moved to the Python guide, simpler mounting from Python with subprocess, merged/removed self-explanatory troubleshooting entries, shorter "How it works", bullets instead of a wide table and no Indices section on the front page. Fix: - The Python route also needs git-annex - CONTRIBUTING.md: FUSE packages, the --no-forgejo option (there is no --forgejo, and failing to start the container is fatal by default), and the container image actually used - Cache entries expire a week after they were first cached - Drop a version note and sample outputs that would go stale - --caching help text: fix typo, list the values Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TZnKRgtotR2MqJqkzJfvRU
Documentation build overview
19 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #140 +/- ##
=======================================
Coverage 84.48% 84.48%
=======================================
Files 14 14
Lines 1502 1502
=======================================
Hits 1269 1269
Misses 233 233 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…n-br2ms9 Brings in the switch from fusepy to mfusepy (#139). Conflicts: - CONTRIBUTING.md, docs/source/installation.rst: take master's FUSE installation instructions (FUSE 3 alone suffices with mfusepy); keep this branch's other changes to the installation page - docs/source/conf.py: keep this branch's autodoc defaults, with master's mfusepy mock Also update the troubleshooting entry for failing reads in the mount: with mfusepy, programs see "Invalid argument" and `datalad fusefs` prints the actual error, instead of fusepy's "Numerical result out of range". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TZnKRgtotR2MqJqkzJfvRU
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.
Follow-up to #138, based on an independent review of the merged documentation: claims were checked against the code, and the built HTML was crawled with Playwright.
Rendering
--. Sphinx smartquotes had turned them into en dashes (e.g.–foreground) in the command line reference and in search results, so copied options did not work.[gh-actions](deps)now shows as plain text instead of broken links to#deps, and the warning is no longer suppressed.CONTRIBUTING.md.FileState(*values)signature and no "Bases: object" lines.Content (about 70 lines shorter)
subprocess.Fixes
CONTRIBUTING.md: documents the actual--no-forgejooption (there is no--forgejo, and failing to start the container is fatal by default) and the container image that is actually used.--cachinghelp text: typo fixed, allowed values listed.Merge with master (mfusepy, #139)
mfusepyimports.datalad fusefsprints the actual error. The old entry described fusepy's misleading "Numerical result out of range".Verification
sphinx -Wpasses; the only remaining warnings are intersphinx downloads blocked in the sandbox where this was prepared.dandisets/000582, including mounting with mfusepy.🤖 Generated with Claude Code
https://claude.ai/code/session_01TZnKRgtotR2MqJqkzJfvRU