docs: fix typos across guides, tutorials and integrations - #3117
Open
toyeshhm wants to merge 3 commits into
Open
docs: fix typos across guides, tutorials and integrations#3117toyeshhm wants to merge 3 commits into
toyeshhm wants to merge 3 commits into
Conversation
Eleven corrections, all single-word except one: - `Critera` / `Critiera` in the G-Eval use-case tables, both meant `Criteria` - `criterias` -> `criteria` (already plural) - `behavious` -> `behavior`, matching the American spelling used elsewhere - `Youn`, `functionalies`, `retrive`, `perfoms`, and two `everytime` -> `every time` The Weaviate page also read "This parameters include"; changed to "These".
|
@toyeshhm is attempting to deploy a commit to the Confident AI Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR corrects multiple typos/wording issues across the documentation (guides, tutorials, integrations, and blog posts) to improve readability and consistency.
Changes:
- Fixes spelling/wording issues such as “everytime” → “every time”, “behavious” → “behavior”, and “criterias” → “criteria”.
- Standardizes the G-Eval use-case table column header spelling to “Criteria”.
- Applies a small grammar correction in the Weaviate integration doc.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/content/tutorials/summarization-agent/evaluation.mdx | Fixes “everytime” → “every time” in dataset explanation. |
| docs/content/tutorials/rag-qa-agent/evaluation.mdx | Fixes “behavious” → “behavior” in a note about hyperparameters. |
| docs/content/tutorials/medical-chatbot/improvement.mdx | Fixes “perfoms” → “performs” in tutorial narrative. |
| docs/content/tutorials/medical-chatbot/evals-in-prod.mdx | Fixes “retrive” → “retrieve” inside a Python snippet docstring (but leaves a quoting issue). |
| docs/content/tutorials/medical-chatbot/development.mdx | Fixes “functionalies” → “functionalities” in intro text. |
| docs/content/integrations/vector-databases/weaviate.mdx | Fixes “Youn” → “You” and “This parameters” → “These parameters”. |
| docs/content/guides/guides-answer-correctness-metric.mdx | Fixes “criterias” → “criteria” in the guide narrative. |
| docs/content/blog/top-5-geval-use-cases.mdx | Fixes “Critera/Critiera” → “Criteria” in tables. |
| docs/content/blog/deepeval-vs-ragas.mdx | Fixes “everytime” → “every time” in the blog post narrative. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @observe(metrics=[ContextualRelevancyMetric()], type="retriever") | ||
| def query_engine(self, query: str) -> str: | ||
| """"A tool to retrive data on various diagnosis methods from gale encyclopedia""" | ||
| """"A tool to retrieve data on various diagnosis methods from gale encyclopedia""" |
"of the the MMLU benchmark", "perfect for for subjective tasks", "MeetingSummarizer to to use", and "the number of of text chunks".
The docstring opened with four quotes, so the snippet raised a SyntaxError if copied.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fifteen corrections across the docs.
Worth a second look:
CriteraandCritiera— both meantCriteria.criteriason the answer-correctness guide is already plural; changed tocriteria.behavious->behavior, matching the American spelling the docs use elsewhere (174 occurrences vs 31 British).The rest of the spelling fixes:
Youn,functionalies,retrive,perfoms, and two instances ofeverytime->every time.The second commit fixes four repeated words: "of the the MMLU benchmark", "perfect for for subjective tasks", "MeetingSummarizer to to use", and "the number of of text chunks".
One small grammar fix on the same line as the Weaviate typo: "This parameters include" -> "These parameters include".