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

[Bug] Examples are wrong #7

Open
4 tasks
samgdotson opened this issue Oct 7, 2024 · 0 comments
Open
4 tasks

[Bug] Examples are wrong #7

samgdotson opened this issue Oct 7, 2024 · 0 comments
Assignees
@osanstrong
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:2-Challenging This issue may be complex or require specialized skills. Priority:2-Normal This work is important and should be completed ASAP. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Bug Something is wrong or broken. This issue or PR is related to a bug in code. Type:Test Is related to software testing. Failing tests, necessary new tests, test frameworks, etc.

Comments

@samgdotson
Copy link

Describe the bug.

The example documents in the input and output directories are edited incorrectly and incompletely.

What is the expected behavior?

E.g., "planet" should not be edited to "lanet"

How can this issue be closed?

@osanstrong, this issue can be closed when the scripts correctly edit the example documents. Additionally, I recommend creating smaller "unit tests" that check each function of the writing checker. E.g.,

  • does the checker correctly capitalize words at the start of sentences?
  • does the checker NOT erroneously truncate words (see "planet")?
  • does the checker correctly identifying passive verbs?
  • add more for each item in the checklist...

Consider following a "test driven development" style.
@samgdotson samgdotson added Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:2-Challenging This issue may be complex or require specialized skills. Priority:2-Normal This work is important and should be completed ASAP. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Bug Something is wrong or broken. This issue or PR is related to a bug in code. Type:Test Is related to software testing. Failing tests, necessary new tests, test frameworks, etc. labels Oct 7, 2024
@samgdotson samgdotson mentioned this issue Oct 7, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@osanstrong osanstrong

Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:2-Challenging This issue may be complex or require specialized skills. Priority:2-Normal This work is important and should be completed ASAP. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Bug Something is wrong or broken. This issue or PR is related to a bug in code. Type:Test Is related to software testing. Failing tests, necessary new tests, test frameworks, etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@samgdotson @osanstrong