From 381097e0a75839022c9c958bdd5bb848fe0aa157 Mon Sep 17 00:00:00 2001 From: David Gardner <96306125+dagardner-nv@users.noreply.github.com> Date: Wed, 11 Sep 2024 14:05:38 -0700 Subject: [PATCH] Remove `TODO` statements from documentation (#1879) * 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: https://github.com/nv-morpheus/Morpheus/pull/1879 --- ci/vale/styles/config/vocabularies/morpheus/reject.txt | 1 + docs/source/developer_guide/architecture.md | 2 +- examples/digital_fingerprinting/demo/review_results.md | 1 - 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ci/vale/styles/config/vocabularies/morpheus/reject.txt b/ci/vale/styles/config/vocabularies/morpheus/reject.txt index 07e5703ce1..d16f8aef98 100644 --- a/ci/vale/styles/config/vocabularies/morpheus/reject.txt +++ b/ci/vale/styles/config/vocabularies/morpheus/reject.txt @@ -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 diff --git a/docs/source/developer_guide/architecture.md b/docs/source/developer_guide/architecture.md index 6070304b4f..25bbb96a1c 100644 --- a/docs/source/developer_guide/architecture.md +++ b/docs/source/developer_guide/architecture.md @@ -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. diff --git a/examples/digital_fingerprinting/demo/review_results.md b/examples/digital_fingerprinting/demo/review_results.md index 5e1ee85f40..df2d4f51cc 100644 --- a/examples/digital_fingerprinting/demo/review_results.md +++ b/examples/digital_fingerprinting/demo/review_results.md @@ -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)