Skip to content

copilot-core: Haddock comment for test property contains typo #783

Closed

Description

@ivanperez-keera

Description

The Haddock comment for the property copilot-core:Test.Copilot.Core.Type.testTypeLength2 states that it tests "that the length of an multi-dimensional array is as expected", which is grammatically incorrect.

To make documentation most useful and in compliance with our style guide, the documentation should have no typos or grammatical errors.

Type

  • Bug: Typo 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:Test.Copilot.Core.Type. The comment that precedes testTypeLength2 incorrectly says "an multi-dimensional array".

Expected result

The documentation of copilot-core:Test.Copilot.Core.Type.testTypeLength2 is grammatically correct.

Desired result

The documentation of copilot-core:Test.Copilot.Core.Type.testTypeLength2 is grammatically correct.

Proposed solution

Fix the typo in the documentation of copilot-core:Test.Copilot.Core.Type.testTypeLength2.

Further notes

None.

Activity

  1. added
    CR:Type:BugAdmin only: Change request pertaining to error detected
    CR:Status:InitiatedAdmin only: Change request that has been initiated
    on Oct 17, 2026
  2. ivanperez-keera commented on Oct 18, 2026

    @ivanperez-keera
    MemberAuthor

    Change Manager: Confirmed that the issue exists.

  3. added
    CR:Status:ConfirmedAdmin only: Change request that has been acknowledged by the change manager
    and removed
    CR:Status:InitiatedAdmin only: Change request that has been initiated
    on Oct 18, 2026
  4. ivanperez-keera commented on Oct 18, 2026

    @ivanperez-keera
    MemberAuthor

    Technical Lead: Confirmed that the issue should be addressed.

  5. added
    CR:Status:AcceptedAdmin only: Change request accepted by technical lead
    and removed
    CR:Status:ConfirmedAdmin only: Change request that has been acknowledged by the change manager
    on Oct 18, 2026
  6. ivanperez-keera commented on Oct 18, 2026

    @ivanperez-keera
    MemberAuthor

    Technical Lead: Issue scheduled for fixing in Copilot 4.8.2.

    Fix assigned to: @ivanperez-keera.

  7. added
    CR:Status:ScheduledAdmin only: Change requested scheduled
    and removed
    CR:Status:AcceptedAdmin only: Change request accepted by technical lead
    on Oct 18, 2026
  8. added this to the 4.8.2 milestone on Oct 18, 2026
  9. added
    CR:Status:ImplementationAdmin only: Change request that is currently being implemented
    and removed
    CR:Status:ScheduledAdmin only: Change requested scheduled
    on Oct 18, 2026
  10. ivanperez-keera commented on Oct 18, 2026

    @ivanperez-keera
    MemberAuthor

    Implementor: Solution implemented, review requested.

  11. added
    CR:Status:VerificationAdmin only: Change request that is currently being verified
    and removed
    CR:Status:ImplementationAdmin only: Change request that is currently being implemented
    on Oct 18, 2026
  12. ivanperez-keera commented on Oct 18, 2026

    @ivanperez-keera
    MemberAuthor

    Change Manager: Verified that:

    • Solution is implemented:
    • Implementation is documented. Details:
      Change is to the documentation.
    • Change history is clear.
    • Commit messages are clear.
    • Changelogs are updated.
    • Examples are updated. Details:
      No updates needed; change does not affect existing examples.
    • Author is internal or has provided signed CLA.
    • Required version bumps are evaluated. Details:
      Bump not needed; change is to the tests and does not affect the public API.
  13. ivanperez-keera commented on Oct 18, 2026

    @ivanperez-keera
    MemberAuthor

    Change Manager: Implementation ready to be merged.

  14. added
    CR:Status:ClosedAdmin only: Change request that has been completed
    and removed
    CR:Status:VerificationAdmin only: Change request that is currently being verified
    on Oct 18, 2026
  15. added a commit that references this issue on Oct 18, 2026
    8c2048d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

CR:Status:ClosedAdmin only: Change request that has been completedCR:Type:BugAdmin only: Change request pertaining to error detected

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions