docs: fix inaccurate content and grammar errors in documentation#1411
Open
alelpoan wants to merge 2 commits into
Open
docs: fix inaccurate content and grammar errors in documentation#1411alelpoan wants to merge 2 commits into
alelpoan wants to merge 2 commits into
Conversation
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.
Description
Fix inaccurate content and grammar errors across documentation pages.
in—a 10ms sync call in at 2,000 concurrent rollouts→a 10ms sync call at 2,000 concurrent rollouts-sflag. The flag saves results to disk (--save-results), not prints sample outputs, as documented in the evaluation.md command reference.Type of Change
Testing
uv run pytestlocally.Checklist
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.mdto correct the concurrency example wording in the performance section, and removes an incorrect claim indocs/faqs.mdabout the-sflag 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
-sflag printing sample outputs from the quickstart section in docs/faqs.md.Macroscope summarized 799f997.