docs: fix broken TOC anchor, C# comment syntax, and grammar typo in README#14
Merged
Conversation
…EADME Resolves the three issues reported in Natvs#5: - TOC link "Customising the automate" pointed to a dead anchor; the heading is "Customising the automaton". Updated link text and anchor to match. - The C# example block under "Add states and transitions" used `#` for comments (Python/shell syntax); changed to `//` for C#. - Fixed grammar: "components of largely customisable" -> "components are largely customisable".
Owner
|
Hello Biboete. Sorry for seeing this PR so late and thanks for contributing. I'll consider a new issue for the problem you mentionned. |
Owner
|
I have just reported your issue along with some other corrections in documentation in #17 . Feel free to contribute to this one too ;) |
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.
Fixes #5.
This addresses the three documentation issues reported in the README:
#customising-the-automate, but the section heading is "Customising the automaton" (anchor#customising-the-automaton), so the link didn't resolve. Updated the link text and anchor to match the heading.#comments (Python/shell style) inside a```csharpfence. Changed them to//.Scope is kept to exactly the three reported items.
Minor heads-up (not changed here to keep the diff focused): the same example has
new Transition(tokenB, stateB)))with an extra closing paren — happy to fix that in a follow-up if you'd like.