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

Word in reject.txt not flagged as error if it appears in a bullet list #893

Open
1 task done
dagardner-nv opened this issue Aug 30, 2024 · 0 comments
Open
1 task done

Word in reject.txt not flagged as error if it appears in a bullet list #893

dagardner-nv opened this issue Aug 30, 2024 · 0 comments
Labels
Type: Bug

Comments

@dagardner-nv
Copy link

Check for existing issues

  • Completed

Environment

  • Linux, Debian 12.6
  • Conda
  • 3.7.1

Describe the bug / provide steps to reproduce it

I added the word TODO to my reject.txt file, however vale fails to recognize the word when it appears in a markdown bullet list.
Full repro is available at: https://github.com/dagardner-nv/vale_rejected_word_in_list

README.md:

# Test

The word "TODO" appears in the `reject.txt` file. Vale will correctly flag this line as an error but will ignore the one appearing in the bullet list below.

* bullet list
* Module Layer
    * TODO: Add details about modules.

Output, vale correctly identifies the TODO on line 3, but fails to identify the occurrence on line 7:

$ vale README.md 

 README.md
 3:11  error  Avoid using 'TODO'.  Vale.Avoid 

✖ 1 error, 0 warnings and 0 suggestions in 1 file.
@dagardner-nv dagardner-nv mentioned this issue Aug 30, 2024
Merged
rapids-bot bot pushed a commit to nv-morpheus/Morpheus that referenced this issue Sep 11, 2024
@dagardner-nv
Remove TODO statements from documentation (#1879)
381097e 
* Remove `TODO` statements from documentation
* Add the word `TODO` to the `reject.txt` file, although due to errata-ai/vale#893 this does not guarantee occurrences will always be flagged.

Closes #1877

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md).
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #1879
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dagardner-nv