docs: Improve docs' prose - #303
Open
thomaspinder wants to merge 1 commit into
Open
thomaspinder wants to merge 1 commit into
thomaspinder wants to merge 1 commit into
Conversation
…torial prose
Detect-then-edit pass with the avoid-ai-writing skill (docs profile,
technical carve-outs). Prose-only: no code cells, metadata, math, or
markup touched; all notebooks round-trip through jupytext.
- ~250 em dashes restructured into commas, parentheses, colons, and
sentence splits across 21 files; zero remain in prose (code-fence
comments and figure-caption strings excluded). No single-hyphen
fallbacks were needed.
- All negation-pivot stacking removed: 8 rewrites in monetary-policy,
2 in granger-causality, all positive-first with meaning preserved.
- Repetition condensed: monetary-policy's precision-vs-honesty thesis
and structural-analysis's ordering-debate contrast each stated once
(plus a closing treatment); identification.md's ordering admonition
no longer restates its own body text.
- Self-praise cut ("a compelling demonstration of what structural VAR
models can do"), both intensifier "genuinely"s dropped, and ~10
copy-editing bugs fixed ("tell us tell us", "we can see observe",
a garbled proxy-svar instrument sentence).
Verified: make docs-ci green under -W; independent grep sweeps confirm
zero prose dashes; jupytext parse checks pass on all eleven notebooks.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0176rwJjARdWpgLinqA2qQtc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs/polish #303 +/- ##
=============================================
- Coverage 96.1% 96.1% -0.1%
=============================================
Files 55 55
Lines 3548 3547 -1
Branches 441 441
=============================================
- Hits 3410 3409 -1
Misses 102 102
Partials 36 36 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
thomaspinder
changed the title
This branch has not been deployed
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.
Improve prose