diff --git a/cspell.json b/.cspell.json similarity index 94% rename from cspell.json rename to .cspell.json index e58237b2941..e0bc12e624a 100644 --- a/cspell.json +++ b/.cspell.json @@ -24,8 +24,7 @@ "scripts/docs/_build/**", "src/promptflow/promptflow/azure/_restclient/flow/**", "src/promptflow/tests/**", - "**/flow.dag.yaml", - "docs/cloud/azureai/faq.md" + "**/flow.dag.yaml" ], "words": [ "propmtflow", @@ -52,7 +51,6 @@ "logit", "hnsw", "chatml", - "dtype", "UNLCK", "KHTML", "numlines", @@ -68,7 +66,10 @@ "pfutil", "mgmt", "wsid", - "westus" + "westus", + "msrest", + "cref", + "msal" ], "ignoreWords": [ "openmpi", @@ -118,11 +119,13 @@ "continuumio", "pydantic", "iterrows", + "dtype", "fillna", "nlines", "aggr", "tcsetattr", - "pysqlite" + "pysqlite", + "AADSTS700082" ], "allowCompoundWords": true } diff --git a/.github/workflows/spell_check.yml b/.github/workflows/spell_check.yml index 3b50cd5fd72..6b3e9dc7ca0 100644 --- a/.github/workflows/spell_check.yml +++ b/.github/workflows/spell_check.yml @@ -25,4 +25,6 @@ jobs: run: npm install -g cspell - name: Run cspell - run: cspell lint "**" + run: |- + cspell lint "**" + echo -e "\e[91mNote: If the detected words are expected, add them in ".cspell.json".\e[0m" diff --git a/docs/dev/documentation_guidelines.md b/docs/dev/documentation_guidelines.md index 9fba788ec1c..d8890993710 100644 --- a/docs/dev/documentation_guidelines.md +++ b/docs/dev/documentation_guidelines.md @@ -140,7 +140,7 @@ You can build the documentation site locally to preview the final effect of your 4. Check warnings/errors in the build log, fix them if any, then build again. 5. Open `scripts/docs/_build/index.html` to preview the local doc site. -## Aditional comments +## Additional comments - **Utilities**: The [autoDocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) VSCode extension or GitHub Copilot can help autocomplete in this style for you. diff --git a/src/promptflow-tools/tests/test_aoai.py b/src/promptflow-tools/tests/test_aoai.py index 81795de9ad0..0fa4fa9ab4d 100644 --- a/src/promptflow-tools/tests/test_aoai.py +++ b/src/promptflow-tools/tests/test_aoai.py @@ -34,7 +34,7 @@ def test_aoai_chat(self, aoai_provider, example_prompt_template, chat_history): user_input="Fill in more details about trend 2.", chat_history=chat_history, ) - assert "details about trend 2" in result.lower() + assert "additional details you can include" in result.lower() def test_aoai_chat_api(self, azure_open_ai_connection, example_prompt_template, chat_history): result = chat( @@ -93,7 +93,7 @@ def test_aoai_stream_chat(self, aoai_provider, example_prompt_template, chat_his answer += next(result) except Exception: break - assert "details about trend 2" in answer.lower() + assert "additional details you can include" in answer.lower() @pytest.mark.parametrize( "params, expected",