Skip to content

Fix typos and style issues in documentation - #400

Merged
PJK merged 1 commit into
masterfrom
fix-doc-low
Feb 8, 2026
Merged

PJK merged 1 commit into
masterfrom
fix-doc-low

Conversation

@PJK

@PJK PJK commented Feb 8, 2026

Copy link
Copy Markdown
Owner

Summary

Fixes 14 typos, grammar issues, and broken links across 11 files:

  • getting_started.rst: "If you include" -> "If your include"; "the path path" -> "the path"
  • tutorial.rst: "Examples of of" -> "Examples of"
  • decoding.rst: Legend abbreviation "PSD" -> "PDS" to match diagram
  • item_reference_counting.rst: "gives you with" -> "gives you"
  • internal.rst: "there decoding" -> "the decoding"; "Used both by both" -> "Used by both"
  • type_5_maps.rst: "Map are" -> "Maps are"
  • type_6_tags.rst: "Tag are" -> "Tags are"
  • type_7_floats_ctrls.rst: Fix missing _ in RST link for float; remove extra ) in Signaling NaN URL
  • standard_conformance.rst: Fix missing _ in RST link for float
  • development.rst: Convert Markdown link to RST syntax
  • README.md: "an proprietary" -> "and proprietary"; "using using" -> "using"

Test plan

  • All 26 tests pass
  • Visual review of all changes

🤖 Generated with Claude Code

- Fix "If you include" -> "If your include" (getting_started.rst)
- Fix "the path path" -> "the path" (getting_started.rst)
- Fix "Examples of of" -> "Examples of" (tutorial.rst)
- Fix "PSD" -> "PDS" in diagram legend (decoding.rst)
- Fix "gives you with" -> "gives you" (item_reference_counting.rst)
- Fix "there decoding" -> "the decoding" (internal.rst)
- Fix "Used both by both" -> "Used by both" (internal.rst)
- Fix "Map are" -> "Maps are" (type_5_maps.rst)
- Fix "Tag are" -> "Tags are" (type_6_tags.rst)
- Fix broken RST links for float type (type_7_floats_ctrls.rst,
  standard_conformance.rst)
- Fix extra ) in Signaling NaN URL (type_7_floats_ctrls.rst)
- Fix Markdown link syntax in RST file (development.rst)
- Fix "an proprietary" -> "and proprietary" (README.md)
- Fix "using using" -> "using" (README.md)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@PJK
PJK merged commit d292333 into master Feb 8, 2026
13 of 16 checks passed
@PJK
PJK deleted the fix-doc-low branch February 8, 2026 19:26
@codecov

codecov Bot commented Feb 8, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (4813d51) to head (aaa07ed).
⚠️ Report is 24 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master      #400      +/-   ##
===========================================
+ Coverage   99.87%   100.00%   +0.12%     
===========================================
  Files          20        20              
  Lines        1663      1663              
===========================================
+ Hits         1661      1663       +2     
+ Misses          2         0       -2     

☔ View full report in Codecov by Sentry.
📢 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.

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.

1 participant

⌂ 换网址