Various typos #6313
Various typos #6313
Conversation
WalkthroughVarious documentation and policy text corrections: fixed typos, punctuation, spacing, and minor wording across multiple docs and one core docstring file. No functional, API, or control-flow changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/source/index.rst (2)
319-319: Fix typo: "you data" → "your data".User-facing text; please correct.
- :description: Are you using embeddings to analyze your data and models? Use FiftyOne's embeddings visualization capabilities to reveal hidden structure in you data, mine hard samples, pre-annotate data, recommend new samples for annotation, and more. + :description: Are you using embeddings to analyze your data and models? Use FiftyOne's embeddings visualization capabilities to reveal hidden structure in your data, mine hard samples, pre-annotate data, recommend new samples for annotation, and more.
333-333: Grammar: "Annotations mistakes" → "Annotation mistakes".Singular adjective form.
- :description: Annotations mistakes create an artificial ceiling on the performance of your model. However, finding these mistakes by hand is not feasible! Use FiftyOne to automatically identify possible label mistakes in your datasets. + :description: Annotation mistakes create an artificial ceiling on the performance of your model. However, finding these mistakes by hand is not feasible! Use FiftyOne to automatically identify possible label mistakes in your datasets.
🧹 Nitpick comments (1)
docs/source/index.rst (1)
417-417: Wording nit: avoid “powerful machine learning-powered”.Redundant phrasing; simplify to “ML-powered”.
-The FiftyOne Brain is a library of powerful machine learning-powered +The FiftyOne Brain is a library of ML-powered
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/source/index.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (1)
docs/source/index.rst (1)
462-464: Typo fix LGTM."als" → "also" reads correctly; no semantic changes introduced.
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
ISSUE_POLICY.md (1)
54-54: Fix article usage: “A FiftyOne …”, not “An FiftyOne …”.Update four occurrences for grammatical correctness.
Apply this diff:
- feature as an FiftyOne Plugin. + feature as a FiftyOne Plugin. -3. An FiftyOne maintainer reproduces the bug and provides feedback about how to +3. A FiftyOne maintainer reproduces the bug and provides feedback about how to -3. An FiftyOne maintainer confirms the documentation issue and provides +3. A FiftyOne maintainer confirms the documentation issue and provides -3. An FiftyOne maintainer confirms the installation issue and provides feedback +3. A FiftyOne maintainer confirms the installation issue and provides feedbackAlso applies to: 65-65, 83-83, 99-99
🧹 Nitpick comments (3)
ISSUE_POLICY.md (3)
64-64: Tighten phrasing: remove stray “request”."route to request appropriate maintainers" → "route to appropriate maintainers".
- route to request appropriate maintainers. + route to appropriate maintainers.
46-46: Concise style: “indicate priority” reads better.Swap “give an indication of priority” with “indicate priority” for brevity.
- ... needed from the author, give an indication of priority, and route ... + ... needed from the author, indicate priority, and route ...Also applies to: 63-63, 80-80, 97-97
22-22: Optional: standardize heading capitalization.Choose either Title Case or sentence case across section headings for consistency (currently “Feature Requests” vs “Bug reports/Documentation fixes/Installation issues”).
Also applies to: 56-56, 73-73, 90-90
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
ISSUE_POLICY.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
ISSUE_POLICY.md
[grammar] ~95-~95: There might be a mistake here.
Context: ... the issue and the platforms it affects. 2. The issue is triaged ...
(QB_NEW_EN)
[style] ~97-~97: ‘give an indication of’ might be wordy. Consider a shorter alternative.
Context: ...formation is needed from the author, give an indication of priority, and route the issue to app...
(EN_WORDINESS_PREMIUM_GIVE_AN_INDICATION_OF)
[grammar] ~98-~98: There might be a mistake here.
Context: ...the issue to appropriate maintainers. 3. An FiftyOne maintainer confirms the inst...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ...eedback about how to implement a fix. 4. After an approach has been agreed upon, ...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...lation issues to ensure a timely fix. 5. The fix owner begins implementing the fi...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
ISSUE_POLICY.md (2)
95-95: LGTM: grammar fix reads correctly."the platforms it affects" is correct and clearer than the prior phrasing.
102-103: LGTM: merged fragment improves readability.The sentence now scans cleanly and preserves intent.
CharlesCNorton
force-pushed
the
various-doc-fixes
branch
from
3cbbfa4 to
7b09a00
Compare
- Fixed typos in multiple documentation files - Corrected 'coorindate' to 'coordinate' in labels.py - Fixed grammar and spelling errors across user guides and integration docs
CharlesCNorton
force-pushed
the
various-doc-fixes
branch
from
7b09a00 to
ca4119e
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
ISSUE_POLICY.md(1 hunks)docs/source/brain.rst(2 hunks)docs/source/enterprise/app.rst(2 hunks)docs/source/enterprise/data_quality.rst(1 hunks)docs/source/enterprise/dataset_versioning.rst(1 hunks)docs/source/index.rst(3 hunks)docs/source/installation/troubleshooting.rst(2 hunks)docs/source/integrations/milvus.rst(2 hunks)docs/source/integrations/mongodb.rst(1 hunks)docs/source/integrations/pinecone.rst(1 hunks)docs/source/user_guide/app.rst(1 hunks)docs/source/user_guide/draw_labels.rst(1 hunks)docs/source/user_guide/export_datasets.rst(1 hunks)docs/source/user_guide/plots.rst(1 hunks)fiftyone/core/labels.py(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-10T03:01:27.501Z
Learnt from: swheaton
PR: voxel51/fiftyone#6334
File: fiftyone/core/expressions.py:2727-2741
Timestamp: 2025-09-10T03:01:27.501Z
Learning: FiftyOne requires MongoDB >= 6.0 as documented at https://docs.voxel51.com/user_guide/config.html#using-a-different-mongodb-version
Applied to files:
docs/source/integrations/mongodb.rst
📚 Learning: 2025-09-10T19:53:08.432Z
Learnt from: AdonaiVera
PR: voxel51/fiftyone#6337
File: docs/source/tutorials/dinov3.ipynb:121-124
Timestamp: 2025-09-10T19:53:08.432Z
Learning: The `foz.load_zoo_dataset()` function supports loading datasets from external sources including GitHub URLs (e.g., "https://github.com/voxel51/coco-2017"), which is different from loading built-in zoo datasets by name (e.g., "coco-2017"). GitHub URL loading allows access to custom datasets not available in the standard FiftyOne Dataset Zoo.
Applied to files:
docs/source/index.rst
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: test / test-python (ubuntu-latest-m, 3.10)
- GitHub Check: test-windows / test-python (windows-latest, 3.11)
- GitHub Check: test-windows / test-python (windows-latest, 3.10)
- GitHub Check: test-windows / test-python (windows-latest, 3.12)
- GitHub Check: test-windows / test-python (windows-latest, 3.9)
- GitHub Check: test / test-python (ubuntu-latest-m, 3.12)
- GitHub Check: test / test-python (ubuntu-latest-m, 3.11)
- GitHub Check: test / test-python (ubuntu-latest-m, 3.9)
- GitHub Check: e2e / test-e2e
- GitHub Check: test / test-app
- GitHub Check: build / build
- GitHub Check: build
🔇 Additional comments (2)
docs/source/user_guide/plots.rst (1)
49-50: Clean doc phrasingRemoving the redundant “attribute” makes the sentence read smoothly. Nice catch.
docs/source/user_guide/draw_labels.rst (1)
49-49: Nice grammar fix.“render” reads correctly now. ✅
| If you encounter a `psutil.NoSuchProcessExists` exists when importing | ||
| `fiftyone`, you are likely missing the C++ libraries MongoDB requires. | ||
|
|
There was a problem hiding this comment.
Fix typo in psutil error description.
The text references a nonexistent psutil.NoSuchProcessExists symbol and still has a duplicated “exists”. Please correct the exception name and sentence.
Apply this patch:
-If you encounter a `psutil.NoSuchProcessExists` exists when importing
-`fiftyone`, you are likely missing the C++ libraries MongoDB requires.
+If you encounter a `psutil.NoSuchProcess` error when importing `fiftyone`,
+you are likely missing the C++ libraries that MongoDB requires.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you encounter a `psutil.NoSuchProcessExists` exists when importing | |
| `fiftyone`, you are likely missing the C++ libraries MongoDB requires. | |
| If you encounter a `psutil.NoSuchProcess` error when importing `fiftyone`, | |
| you are likely missing the C++ libraries that MongoDB requires. |
🤖 Prompt for AI Agents
In docs/source/installation/troubleshooting.rst around lines 243 to 245, the
sentence incorrectly references a nonexistent psutil.NoSuchProcessExists symbol
and repeats the word "exists"; update the exception name to psutil.NoSuchProcess
and remove the duplicated "exists", rewriting the sentence to read something
like: "If you encounter a `psutil.NoSuchProcess` when importing `fiftyone`, you
are likely missing the C++ libraries MongoDB requires." Ensure backticks
surround the exception and module name exactly as shown.
2 participants
Various typo fixes. The first being:
als -> also in index.rst
Summary by CodeRabbit