Skip to content

docs: fix inaccurate content and grammar errors in documentation#1411

Open
alelpoan wants to merge 2 commits into
PrimeIntellect-ai:mainfrom
alelpoan:docs/fix-inaccurate-content-and-grammar
Open

docs: fix inaccurate content and grammar errors in documentation#1411
alelpoan wants to merge 2 commits into
PrimeIntellect-ai:mainfrom
alelpoan:docs/fix-inaccurate-content-and-grammar

Conversation

@alelpoan
Copy link
Copy Markdown

@alelpoan alelpoan commented May 18, 2026

Description

Fix inaccurate content and grammar errors across documentation pages.

  • environments.md: removed duplicate preposition ina 10ms sync call in at 2,000 concurrent rolloutsa 10ms sync call at 2,000 concurrent rollouts
  • faqs.md: removed incorrect statement about the -s flag. The flag saves results to disk (--save-results), not prints sample outputs, as documented in the evaluation.md command reference.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Test improvement

Testing

  • All existing tests pass when running uv run pytest locally.
  • New tests have been added to cover the changes

Checklist

  • My code follows the style guidelines of this project as outlined in AGENTS.md
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Additional Notes

Documentation-only change; no code paths affected.


Note

Low Risk
Low risk documentation-only edits that correct wording and remove an inaccurate CLI flag description; no runtime behavior changes.

Overview
Fixes minor documentation inaccuracies.

Updates docs/environments.md to correct the concurrency example wording in the performance section, and removes an incorrect claim in docs/faqs.md about the -s flag printing sample outputs.

Reviewed by Cursor Bugbot for commit 799f997. Bugbot is set up for automated code reviews on this repo. Configure here.

Note

Fix inaccurate content and grammar errors in documentation

  • Removes an extra word in docs/environments.md so the Performance section reads 'a 10ms sync call at 2,000 concurrent rollouts'.
  • Removes an inaccurate sentence about the -s flag printing sample outputs from the quickstart section in docs/faqs.md.

Macroscope summarized 799f997.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant