diff --git a/docs/tools/README.md b/docs/tools/README.md index 0692fa9c1b..28dfba2a44 100644 --- a/docs/tools/README.md +++ b/docs/tools/README.md @@ -55,5 +55,8 @@ This script will run all (or selected) docs markdown files through the open ai a python fix_grammar_gpt.py # Fix grammar for all files that have the string "walkthrough" in the filepath -python check_embedded_snippets.py -f walkthrough +python fix_grammar_gpt.py -f walkthrough + +# Fix grammar for the particular file +python fix_grammar_gpt.py -f ../website/docs/intro.md ``` diff --git a/docs/tools/fix_grammar_gpt.py b/docs/tools/fix_grammar_gpt.py index 8eb445b577..1e4cf748dd 100644 --- a/docs/tools/fix_grammar_gpt.py +++ b/docs/tools/fix_grammar_gpt.py @@ -41,7 +41,7 @@ parser.add_argument( "-f", "--files", - help="Filter .md files to files containing this string in filename", + help="Specify the file name. Grammar Checker will filter all .md files containing this string in the filepath.", type=str, )