Fix typos, formatting for contrib readmes#437
Merged
chrisib merged 43 commits intoAllen-Synthesis:mainfrom Jun 6, 2025
Merged
Conversation
…ased configuration. Remove configuration JSON instructions & replace with link to the configuration page
…age. Explain the mathematics a little more clearly
…it doesn't contain anything meaningful
…ection after the intro to stay consistent with everything else
chrisib
changed the title
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
1 participant
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.
Go through all of the
contribdocumentation files and fix typos and formatting errors.I've tried to make sure every readme at minimum has an introductory summary section and a
controlsorinputs & outputssection immediately after to explain basic operation as a quick reference. All detailed explanations, examples, credits, etc... come after that.I've also removed the author & tag information from the readmes; those are included in the main contrib readme, and for the sake of consistency it was easier to remove this duplication from the minority of files that had it than to create this information for the ones where it was omitted.