Skip to content

Commit 723233f

Browse files
committed
Update fix grammar instructions
1 parent 65af4f1 commit 723233f

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

docs/tools/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,8 @@ This script will run all (or selected) docs markdown files through the open ai a
5555
python fix_grammar_gpt.py
5656

5757
# Fix grammar for all files that have the string "walkthrough" in the filepath
58-
python check_embedded_snippets.py -f walkthrough
58+
python fix_grammar_gpt.py -f walkthrough
59+
60+
# Fix grammar for the particular file
61+
python fix_grammar_gpt.py -f ../website/docs/intro.md
5962
```

docs/tools/fix_grammar_gpt.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
parser.add_argument(
4242
"-f",
4343
"--files",
44-
help="Filter .md files to files containing this string in filename",
44+
help="Specify the file name. Grammar Checker will filter all .md files containing this string in the filepath.",
4545
type=str,
4646
)
4747

0 commit comments

Comments
 (0)