Skip to content

Commit

Permalink
Update missing_doc_comment_openai formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
smoelius committed Jul 7, 2023
1 parent 26c8b06 commit f55ab94
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion examples/restriction/missing_doc_comment_openai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion examples/restriction/missing_doc_comment_openai/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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).
///
Expand Down

0 comments on commit f55ab94

Please sign in to comment.