docs: the composition how-to shows a sum that one file defines and other files add terms to - #800
Merged
Merged
Conversation
…her files add terms to The how-to gains a step where the network defines Bus_injection as Bus_slack and the component files add their terms after it. A one-line override patch is said to keep dims:, the description and adds_to:. The tutorial's refusal without the network says no file reads the sum, which is what the message says. The Terms section of the language reference lists its load checks and its merge rules as two lists, and the compose table row links to it. Terms section, sentence lengths: before n 28 avg 17.5 median 19 over25 2; after n 27 avg 18.2 median 19 over25 3. compose.md: before n 59 avg 15.4 median 15 over25 5; after n 64 avg 15.4 median 15 over25 5. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BNUaTy5JqkQCjytjg1FtTv
…her files add terms to Adds the changelog line. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BNUaTy5JqkQCjytjg1FtTv
Documentation build overview
24 files changed ·
|
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.
Note
The following content was generated by AI.
What this changes
This fixes the four doc findings from a review of #763. It adds a define-then-add step to the how-to, corrects a stale sentence in the tutorial, states what a one-line
overridepatch keeps, and lists the Terms rules in the reference.Why
The docs of #763 had one sentence that contradicts the code, one behaviour change they did not state clearly, no example of the case the second prompt of #763 asked for, and dense reference prose.
Changes, method, gates, what is not done
Changes.
docs/howto/compose.md, new step 5:network_slack.yamldefinesBus_injectionasBus_slack.merge(['network_slack.yaml', 'generator.yaml', 'load.yaml'])givesBus_slack + Generator_injection + Load_injection, with the definer'sdims:and description. I ran that merge on the head offeat/adds-toto get this result.docs/howto/compose.md, the patch step: a one-line patch replaces only the body. The entry keepsdims:, the description andadds_to:, so the new body carries no dimension outside the keptdims:. Onmain, the string replaced the whole entry. I checked both halves:overridewith'2 * a'keptdims: [g]and the description, and'b'over[s, g]was refused with aDimensionError.docs/howto/compose.md, theadds_to:table row: cut to the definer rule, with a link to the Terms section.docs/several-files.md, "Leave the network out": the prose said no file declaresinjection. It now says no file reads it, other than the two files that add to it. This matches the message printed below it.docs/reference/language/declarations.md, Terms: the load-time checks and the merge rules are now two bulleted lists with bold lead-ins. The "one file alone reads" rule now states its reason. Two unevenly wrapped paragraphs are rewrapped.Sentence measure (the docs-writing skill's script):
compose.mdThe three Terms sentences over 25 words are list items. The script joins two of them to their bold lead-ins.
Gates.
pixi run lint: clean.pixi run ci:testgave 2611 passed.docs-buildstopped on one warning, the unresolvedpathlib.Pathautoref: the session's proxy blocksdocs.python.org/3/objects.inv. It reported no dead anchor.compile-texdid not run, becausecistopped before it. No file underexamples/changed.tools.changelog entryaccepts this title against the base changelog.compose.mdis a hand-written fence that no test reads. I loaded and merged it by hand, as above.Not done.
adds_to:, and no file marks a sum as open #763 does not yet name theoverridechange as a break. This PR does not edit feat(language): a term names the sum it adds to withadds_to:, and no file marks a sum as open #763's body. The row to add to its "Before and after" table:| A one-line patch on a named expression replaces the whole entry, and drops its dims: and description | It replaces only the body, and the entry keeps dims:, the description and adds_to: |🤖 Generated with Claude Code
https://claude.ai/code/session_01BNUaTy5JqkQCjytjg1FtTv