Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

copilot-theorem: Typos in README #560

Closed
ivanperez-keera opened this issue Nov 1, 2024 · 6 comments
Closed

copilot-theorem: Typos in README #560

ivanperez-keera opened this issue Nov 1, 2024 · 6 comments
Assignees
@ivanperez-keera
Labels
CR:Status:Closed Admin only: Change request that has been completed CR:Type:Bug Admin only: Change request pertaining to error detected
Milestone
4.3

Comments

@ivanperez-keera
Copy link
Member

Description

The README in copilot-theorem includes several typos, such as proportionnal, occurences and latters.

Those typos should be corrected.

Type

  • Bug: typo in documentation.

Additional context

None.

Requester

  • Ikko Eltociear Ashimine and Ivan Perez

Method to check presence of bug

By visual inspection, potentially using a spell checker for help. The typos are mixed with technical words, to spell checkers cannot automatically tell us with 100% certainty whether all typos have been fixed.

Expected result

The README of copilot-theorem contains no typos.

Desired result

The README of copilot-theorem contains no typos.

Proposed solution

Use a spell checker to find and fix all typos in copilot-theorem, being careful with technical terms that are correct but spell checkers do not understand, such as reification.

Further notes

None.
@ivanperez-keera ivanperez-keera added CR:Type:Bug Admin only: Change request pertaining to error detected CR:Status:Initiated Admin only: Change request that has been initiated labels Nov 1, 2024
@ivanperez-keera
Copy link
Member Author

Change Manager: Confirmed that the issue exists.

@ivanperez-keera ivanperez-keera added CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager and removed CR:Status:Initiated Admin only: Change request that has been initiated labels Nov 1, 2024
@ivanperez-keera
Copy link
Member Author

Technical Lead: Confirmed that the issue should be addressed.

@ivanperez-keera ivanperez-keera added CR:Status:Accepted Admin only: Change request accepted by technical lead and removed CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager labels Nov 1, 2024
@ivanperez-keera ivanperez-keera mentioned this issue Nov 4, 2024
Closed
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
Add typos makefile, workflow and configuration, refs Copilot-Language…
16bbc6b 
…#560

- Only ignore dist- folder
- Try but reject use typos github action
- Write changes for hs-fix-typos
- Add alse (parse "f" then "alse") to expected words
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
UExpr not UEXpr, refs Copilot-Language#560
ce25043
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
Fix typos in .hs files, refs Copilot-Language#560
d962c5a
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
Fix typos in markdown, refs Copilot-Language#560
3f0af84
@philderbeast philderbeast mentioned this issue Jan 8, 2025
Open
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
Add typos makefile, workflow and configuration, refs Copilot-Language…
eb1c3ce 
…#560

- Only ignore dist- folder
- Try but reject use typos github action
- Write changes for hs-fix-typos
- Add alse (parse "f" then "alse") to expected words
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
UExpr not UEXpr, refs Copilot-Language#560
e85bb7a
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
Fix typos in .hs files, refs Copilot-Language#560
94c2104
philderbeast added a commit to up-do/copilot that referenced this issue Jan 8, 2025
@philderbeast
Fix typos in markdown, refs Copilot-Language#560
157ac8d
@ivanperez-keera
Copy link
Member Author

Technical Lead: Issue scheduled for fixing in Copilot 4.3.

Fix assigned to: @ivanperez-keera .

@ivanperez-keera ivanperez-keera added CR:Status:Scheduled Admin only: Change requested scheduled and removed CR:Status:Accepted Admin only: Change request accepted by technical lead labels Jan 25, 2025
@ivanperez-keera ivanperez-keera added this to the 4.3 milestone Jan 25, 2025
@ivanperez-keera ivanperez-keera self-assigned this Jan 25, 2025
@ivanperez-keera ivanperez-keera added CR:Status:Implementation Admin only: Change request that is currently being implemented and removed CR:Status:Scheduled Admin only: Change requested scheduled labels Jan 25, 2025
ivanperez-keera added a commit to ivanperez-keera/copilot that referenced this issue Jan 25, 2025
@ivanperez-keera
copilot-theorem: Fix multiple typos in README. Refs Copilot-Language#560
b22a9ee 
.

The README in copilot-theorem includes several typos, such as
proportionnal, occurences and latters. Those typos should be corrected.

This commit fixes the typos found in the README of this package.
Improving the style of the writing or formatting the code is not part of
the fix.
ivanperez-keera added a commit to ivanperez-keera/copilot that referenced this issue Jan 25, 2025
@ivanperez-keera
copilot-theorem: Document changes in CHANGELOG. Refs Copilot-Language…
b8e4441 
…#560.
@ivanperez-keera ivanperez-keera mentioned this issue Jan 25, 2025
Merged
ivanperez-keera added a commit to ivanperez-keera/copilot that referenced this issue Jan 26, 2025
@ivanperez-keera
copilot-theorem: Fix multiple typos in README. Refs Copilot-Language#560
6886d70 
.

The README in copilot-theorem includes several typos, such as
proportionnal, occurences and latters. Those typos should be corrected.

This commit fixes the typos found in the README. Improving the style of
the writing or formatting the code is not included as part of the fix.
ivanperez-keera added a commit to ivanperez-keera/copilot that referenced this issue Jan 26, 2025
@ivanperez-keera
copilot-theorem: Document changes in CHANGELOG. Refs Copilot-Language…
08d29e1 
…#560.
ivanperez-keera added a commit to ivanperez-keera/copilot that referenced this issue Jan 26, 2025
@ivanperez-keera
copilot-theorem: Fix multiple typos in README. Refs Copilot-Language#560
f652dea 
.

The README in copilot-theorem includes several typos, such as
proportionnal, occurences and latters. Those typos should be corrected.

This commit fixes the typos found in the README. Improving the style of
the writing or formatting the code is not included as part of the fix.
ivanperez-keera added a commit to ivanperez-keera/copilot that referenced this issue Jan 26, 2025
@ivanperez-keera
copilot-theorem: Document changes in CHANGELOG. Refs Copilot-Language…
2d7a06e 
…#560.
@ivanperez-keera
Copy link
Member Author

Implementor: Solution implemented, review requested.

@ivanperez-keera ivanperez-keera added CR:Status:Verification Admin only: Change request that is currently being verified and removed CR:Status:Implementation Admin only: Change request that is currently being implemented labels Jan 26, 2025
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles and passes all tests. Details:
      Build log: https://github.com/Copilot-Language/copilot/runs/36185066616
    • The solution proposed produces the expected result. Details:
      This bug has to do with typos in the README. Because of the amount of technical terms, as well as programming examples, included in the README, there's no easy automated way to verify that all typos and all grammatical mistakes have been corrected. I have opened the README using two spell checkers and a grammar checker and have found no mistakes.
  • Implementation is documented. Details:
    No updates needed; this change is to the documentation.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No updates needed; this change is to the documentation.
  • Required version bumps are evaluated. Details:
    Bump not required; change is to the documentation.

@ivanperez-keera
Copy link
Member Author

Change Manager: Implementation ready to be merged.

@ivanperez-keera ivanperez-keera added CR:Status:Closed Admin only: Change request that has been completed and removed CR:Status:Verification Admin only: Change request that is currently being verified labels Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
CR:Status:Closed Admin only: Change request that has been completed CR:Type:Bug Admin only: Change request pertaining to error detected
Milestone
4.3
Development

No branches or pull requests
1 participant
@ivanperez-keera