docs: expand README and fix typos in example docs#49
Merged
Conversation
Replaces the 7-line README stub with a features overview, quick example, and links to examples. Fixes grammar and spelling errors (interprete, grannar, switchin, inherits, etc.) in both example READMEs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Pytest ReportTest Results
Comment by ✨sambyeol/publish-pytest-action |
Pytest ReportTest Results
Comment by ✨sambyeol/publish-pytest-action |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
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.
Summary
a features list, quick code example, and links to the example projects
examples/calc/README.md:interprete→interpret,grannar→grammar,switchin→switch,subject-verb agreement, duplicate "and", awkward phrasing around
inheritsexamples/sum_of_list/README.md:capitalisation,
type→types, sameinheritsphrasingTest plan
git diff --name-onlyshows only.mdfiles)