docs: convert the user guide to the house style - #597
Merged
Conversation
Full simplified technical English pass over docs/source/user_guide.rst, applying the seven
rules and the approved-term table from the docs skill.
PASS docs/source/user_guide.rst
em-dash 99->0 | semicolon 30->0 | banned 55->20 | words 8514->8491 (-0%)
terms: choose 17->1, pick 5->0, the display 2->0, the unit 6->1, the device 1->0, target 13->9, DSO 5->3
OVERALL: PASS
Style only. No facts, numbers, procedures or step order were changed.
Headings, cross-references, image paths and substitutions are unchanged,
verified mechanically against origin/main. Sphinx builds clean under -n.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
Two cross-page fixes that only showed up once every page was converted. The four-bullet key list is marked in-file as duplicated with quick_start.rst. Both pages were converted independently and bullets 2 and 4 drifted. This is the user_guide half of the reconciled wording; "return to" also violated the go-back rule, and "jump" is what both pages already use for this action. "one-off" was being used three ways on this page. Line 199 describes the same feature menu_map calls a Custom Target, so it now says so. Line 564 is not a Custom Target at all - it comes from an observing list - so it matches line 502's "one-off object". "target" now survives only inside the feature name. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
The active-voice pass rewrote "The PiFinder has been used from about -15C to 40C" as "Owners have used the PiFinder from...", which supplies a subject the source never had. We do not actually know the range came from owners rather than from bench testing, so the rewrite asserts more than the original. Rule 2 allows the passive precisely here: the actor is genuinely unknown. Restored. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
Review flagged both as flattening the manual for no rule-compliance reason. "as your night out demands" is not a phrase anyone says. The original read "different ways to use (or skip!) these features for a great night out". It is now "so use the features you want and skip the rest", which is plainer than either and keeps the reader as the subject. The Name Search entry lost "The Snowball planetary? Cat's Eye? This is the way to find them." to a flat declarative. There was no em-dash, semicolon, passive or auxiliary chain in it - nothing in the style sheet asked for the change. The two questions are restored; the first half of the sentence keeps its improved word order. Simplified does not mean cold, which is what the house voice section says. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
"images of every object in its catalog" overstates what ships. astro_data/pifinder_objects.db holds 149,329 objects, of which 134,158 are double stars, 742 single stars and 90 triples. The non-stellar remainder is 13,758, which matches software.rst's "13,000+ images" almost exactly: the image set covers the extended objects, not the star catalogs. Also fixes the singular "catalog" the conversion flagged; the images span several catalogs. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
The style pass replaced "unit" with "PiFinder" throughout, but missed "appears on those units too" and "New units often ship a version or two behind". Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
Same defect as build_guide: Sphinx copies image sources into _images/ and rewrites the <img src>, but emits a :target: value verbatim as an href, so a source-tree path 404s. The two CATALOG_images screenshots pointed at ../../images/screenshots/. Audited the built HTML: 5 of 7 targets resolved before, 7 of 7 after. The other five on this page already used the _images/ form. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
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.
Full simplified technical English pass over
docs/source/user_guide.rst, using thedocsskill's seven rules and approved-term table. Part of the manual-wide conversion, one PR per file.Measured change
What the converting agent reported
Content changes (added after review)
"images of every object in its catalog" overstated what ships.
astro_data/pifinder_objects.dbholds 149,329 objects, of which 134,158 aredouble stars, 742 single stars and 90 triples. The non-stellar remainder is
13,758, which matches
software.rst's "13,000+ images" almost exactly: theimage set covers the extended objects, not the star catalogs. The sentence now
reads "images of all the extended objects in its catalogs", which also fixes
the singular "catalog" flagged in
FACT_CONCERNS.Two escapes from the unit -> PiFinder rule. "appears on those units too"
and "New units often ship a version or two behind" are now "PiFinders".
Two dead click-to-enlarge links. Same defect as
build_guide: Sphinxemits a
:target:value verbatim as an href, so a source-tree path 404s. Thetwo
CATALOG_imagesscreenshots pointed at../../images/screenshots/.Audited the built HTML: 5 of 7 targets resolved before, 7 of 7 after. The
other five already used the
_images/form.Safety
Every other change in this PR is style only. No numbers, procedures or step order were changed.
Verified mechanically against
origin/mainthat every heading (text and underline character), every:ref:,:doc:, image path, substitution,include::and external URL is unchanged. Headings matter becauseautosectionlabelturns each one into a cross-reference target that other pages depend on, and a rename would break them silently.Sphinx builds clean under
-n(nitpicky).Any
FACT_CONCERNSabove that are not listed under Content changes were deliberately not fixed. They are reported for a maintainer decision, since changing them would be a content edit rather than a style one.🤖 Generated with Claude Code
https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD