Repository navigation
copilot-core: Descriptions of two tests in Test.Copilot.Core.Type are incorrect #781
Description
Description
The Haddock comments that accompany the properties testUpdateStruct and testUpdateStruct, included in the test module copilot-core:Test.Copilot.Core.Type, are incorrect. The comments indicate that the properties test showing a struct, when they are related to updates instead.
All Haddock comments should correctly document the functionality implemented in Copilot.
Type
- Bug: Incorrect Haddock comments in tests.
Additional context
None.
Requester
- Ivan Perez.
Method to check presence of bug
This can only be checked by visual inspection, since the comment is written in plain English and we don't have an automated way of validating them.
Expected result
All Haddock comments for properties in the test modules correctly describe the functionality being tested.
Desired result
All Haddock comments for properties in the test modules correctly describe the functionality being tested.
Proposed solution
Fix the comments of testUpdateStruct and testUpdateStruct, in the test module copilot-core:Test.Copilot.Core.Type, to correctly indicate that they pertain to tests (in the positive and negative case, respectively).
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: @kavehz-nasa.
kavehz-nasa 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/279009624
Evaluated by visual inspection of the changes, which now correctly document those two properties.
Change is to the documentation of two definitions.
No updates needed; the change does not affect the existing examples.
Bump not needed; the change does not affect the public API.
ivanperez-keera commentedon Oct 16, 2026
Change Manager: Implementation ready to be merged.
copilot-core: Fix comments for two tests in `Test.Copilot.Core.Type`.…
copilot-core: Document changes in CHANGELOG. Refs #781.
Merge branch 'develop-core-test-comments'. Close Copilot-Language#781.