Repository navigation
copilot-core: Documentation of Copilot.Core.Spec contains grammatical errors #769
Description
Description
The Haddock documentation associated to the type copilot-core:Copilot.Core.Spec.Stream contains two grammatical errors. The first is the incorrect use of "in" in the sentence "A stream in an infinite succession of values", which causes the sentence to have no verb, and the second is the use of Stream in the second paragraph with no article.
To make documentation most useful and in compliance with our style guide, the documentation should have no typos or grammatical errors.
Type
- Bug: Typos in documentation.
Additional context
None.
Requester
- Ivan Perez.
Method to check presence of bug
Can only be determined by visual inspection of the module copilot-core:Copilot.Core.Spec. The use of "in" in the first sentence makes it incorrect due to lack of a verb. The use of "Stream" with no article in the second sentence is incorrect since the name is not a proper noun or a type name or a plural.
Expected result
The documentation of copilot-core:Copilot.Core.Spec is grammatically correct.
Desired result
The documentation of copilot-core:Copilot.Core.Spec is grammatically correct.
Proposed solution
Fix the two grammatical errors in the documentation of copilot-core:Copilot.Core.Spec.
Further notes
None.
Activity
ivanperez-keera commentedon Oct 12, 2026
Change Manager: Confirmed that the issue exists.
ivanperez-keera commentedon Oct 12, 2026
Technical Lead: Confirmed that the issue should be addressed.
ivanperez-keera commentedon Oct 12, 2026
Technical Lead: Issue scheduled for fixing in Copilot 4.8.2.
Fix assigned to: @ivanperez-keera .
copilot-core: Fix errors in the documentation of `Copilot.Core.Spec`.…
copilot-core: Document changes in CHANGELOG. Refs Copilot-Language#769.
ivanperez-keera commentedon Oct 12, 2026
Implementor: Solution implemented, review requested.
ivanperez-keera commentedon Oct 12, 2026
Change Manager: Verified that:
Build log: https://app.travis-ci.com/github/Copilot-Language/copilot/builds/278977523
Evaluated by visual inspection of the documentation of the module and the fixes proposed.
Change is to the documentation.
No updates needed; change is to the documentation.
Bump not needed; change is to the documentation and does not affect public API.
ivanperez-keera commentedon Oct 12, 2026
Change Manager: Implementation ready to be merged.
Merge branch 'develop-core-doc-errors'. Close Copilot-Language#769.