Repository navigation
copilot: Typos and poor style in README #779
Description
Description
The README contains several typos, missing commas, issues with capitalization, and poor wording in some sentences. For example, Copilot is written as Copilot in some places, but copilot in others, even when referring to the project (as opposed to the library). The sentence "It read temperature as a byte", which accompanies a code example, is grammatically incorrect.
To make the README useful and easy to read, we should fix all syntactic and grammatical errors wherever possible.
Type
- Bug: README contains typos, and other grammar and style errors.
Additional context
None.
Requester
- Ivan Perez.
Method to check presence of bug
This can only be done by visual inspection, since none of the typos are due to wrong spelling of known English words but, rather, proper names, and some of the issues brought up are due to number not matching between a pronoun and a verb. The following issues are identified:
- "incorporated in a project or standalone application. The C99 code generated": into a project would sound more natural since incorporated denotes movement or direction.
- "Catch errors in specifications early using expressive static type system": article missing before "expressive".
- "Copilot you must install a Haskell compiler (GHC) and the package manager": comma missing after "Copilot".
- "To use Copilot you must have a Haskell compiler (GHC) and the package manager": comma missing after "Copilot".
- "There is a TravisCI file at the root of the repository that may help with": the name of the company or service is "Travis CI".
- "It read temperature as a byte": number does not match between "it" and "read", and "temperature" is missing an article.
- "facilitates building copilot applications that run on Arduino": "copilot" should be capitalized.
- "facilitates building copilot applications that run on boards supported by the": "copilot" should be capitalized.
- "Additionally NASA Langley contracts 80LARC17C0004 and NNL09AA00A supported": comma missing after "Additionally".
Expected result
The README does not contain any grammar or style errors. All the above concerns have been addressed.
Desired result
The README does not contain any grammar or style errors. All the above concerns have been addressed.
Proposed solution
Fix all the typos, grammatical errors and poor style choices in the README.
Further notes
None.
Activity
ivanperez-keera commentedon Oct 16, 2026
Change Manager: Confirmed that the issue exists.
ivanperez-keera commentedon Oct 16, 2026
Technical Lead: Confirmed that the issue should be addressed.
ivanperez-keera commentedon Oct 16, 2026
Technical Lead: Issue scheduled for fixing in Copilot 4.8.2.
Fix assigned to: @ivanperez-keera.
copilot: Use "into" instead of "in" when indicating movement in READM…
copilot: Add missing article in README. Refs Copilot-Language#779.
25 remaining items
copilot: Fix spelling of Travis CI in README. Refs Copilot-Language#779.
copilot: Fix discrepancy between pronoun and verb in README. Refs Cop…
copilot: Fix capitalization of Copilot in README. Refs Copilot-Langua…
copilot: Fix capitalization of Copilot in README. Refs Copilot-Langua…
copilot: Add missing comma in README. Refs Copilot-Language#779.
copilot: Document changes in CHANGELOG. Refs Copilot-Language#779.
ivanperez-keera commentedon Oct 16, 2026
Implementor: Solution implemented, review requested.
ivanperez-keera commentedon Oct 16, 2026
Change Manager: Verified that:
Build log: https://app.travis-ci.com/github/Copilot-Language/copilot/builds/279007866
Evaluated by visual inspection of the solution, since there is no convenient mechanism to automatically and deterministically verify that all grammatical errors and style issues have been solved.
Change is to the documentation.
No updates needed; change is to the README.
Bump not needed; change is to the README and does not affect the public API.
ivanperez-keera commentedon Oct 16, 2026
Change Manager: Implementation ready to be merged.
Merge branch 'develop-typos-README'. Close Copilot-Language#779.