diff --git a/examples/restriction/missing_doc_comment_openai/README.md b/examples/restriction/missing_doc_comment_openai/README.md index 447ab12d2..e34817814 100644 --- a/examples/restriction/missing_doc_comment_openai/README.md +++ b/examples/restriction/missing_doc_comment_openai/README.md @@ -32,7 +32,7 @@ suggest a doc comment generated by OpenAI. The prompt sent to OpenAI has the fol An elaborate, high quality rustdoc comment for the above function: ```rust ```` -The prompt's [`stop` parameter] is set to ` ["\n```"] `. Thus, OpenAI should stop generating tokens once the second code block is complete. The suggested doc comment is the one that appears in that code block, if any. +The prompt's [`stop` parameter] is set to `["\n```"]`. Thus, OpenAI should stop generating tokens once the second code block is complete. The suggested doc comment is the one that appears in that code block, if any. The phrase "An elaborate..." is configurable (see below). diff --git a/examples/restriction/missing_doc_comment_openai/src/lib.rs b/examples/restriction/missing_doc_comment_openai/src/lib.rs index 2f046e7a4..4e08a8f9f 100644 --- a/examples/restriction/missing_doc_comment_openai/src/lib.rs +++ b/examples/restriction/missing_doc_comment_openai/src/lib.rs @@ -69,7 +69,7 @@ dylint_linting::impl_late_lint! { /// An elaborate, high quality rustdoc comment for the above function: /// ```rust /// ```` - /// The prompt's [`stop` parameter] is set to ` ["\n```"] `. Thus, OpenAI should stop generating tokens once the second code block is complete. The suggested doc comment is the one that appears in that code block, if any. + /// The prompt's [`stop` parameter] is set to `["\n```"]`. Thus, OpenAI should stop generating tokens once the second code block is complete. The suggested doc comment is the one that appears in that code block, if any. /// /// The phrase "An elaborate..." is configurable (see below). ///