docs: name the example generators as the corpus expansion path - #8
Open
josemontesdeoca wants to merge 1 commit into
Open
docs: name the example generators as the corpus expansion path#8josemontesdeoca wants to merge 1 commit into
josemontesdeoca wants to merge 1 commit into
Conversation
The language repository's example READMEs now attribute their expanded node and edge counts to the reference harness. Say on this side that the per-example generate.ts files are that expansion path, so a reader arriving from either repository finds the same account of where the numbers come from.
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.
Why the change
The corpus READMEs in the language repository now say that their node and edge counts come from this harness's per-entity expansion rather than from mounting
src/, so this names the files on our side that actually perform that expansion and a reader arriving from either repository gets the same account of where the numbers come from.Special things to note
tests/open-prose/examples/<name>/generate.ts. The other three — monorepo-ci, inbox-triage, research-tree — delegate to the shared devtools fixtures underpackages/reactor-devtools/src/fixtures/, so a reader following the sentence lands on a generator whose header comment names the fixture. Worth a one-clause amendment if we would rather the sentence carry that hop itself.Change outline
One paragraph, added after the example-library intro and before the example table, where a reader has just been told the corpus is the tour of the language.
What the sentence points at — 16 generators, of which these 8 back a count the corpus now attributes: