Skip to content

Commit

Permalink
Remove TODO statements from documentation (#1879)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
dagardner-nv authored Sep 11, 2024
1 parent 20f9717 commit 381097e
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 2 deletions.
1 change: 1 addition & 0 deletions ci/vale/styles/config/vocabularies/morpheus/reject.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# List of regular expressions matching words we want to reject. Even though we don't have any words listed this
# file needs to exitst in order for vale to pick up our accept.txt file
# Regular expressions are parsed according to the Go syntax: https://golang.org/pkg/regexp/syntax/
(?i)TODO
2 changes: 1 addition & 1 deletion docs/source/developer_guide/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The organization of Morpheus can be broken down into four different layers. Work
* Composed of one or more nodes, connected by edges.
* All nodes are guaranteed to operate on the same machine, in the same process space.
* Module Layer
* TODO: Add details about modules.
* Similar to stages, modules can builds and connect multiple nodes.
* Node Layer
* Smallest building block in Morpheus.
* Each node operates on the same thread.
Expand Down
1 change: 0 additions & 1 deletion examples/digital_fingerprinting/demo/review_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,5 @@ limitations under the License.

# Review Inference Results GUI

TODO: Need to decide on how to send the selected/flagged logs for retraining using submit control message feature.

![DFP Review Inference Results](./images/dfp_review_inf_results.png)

0 comments on commit 381097e

Please sign in to comment.