Skip to content

Conversation

@blueternalness
Copy link
Contributor

Motivation

This PR fixes typos in the document(https://github.com/open-compass/opencompass/blob/main/docs/en/advanced_guides/needleinahaystack_eval.md). The motivation in this PR is to update the document to provide correct guideline for CLI usage.

Modification

This PR aligns CLI commands in the documents to the actual CLI argument parser.

BC-breaking (Optional)

No.

Use cases (Optional)

N/A

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects.
  • CLA has been signed and all committers have signed the CLA in this PR.

@tonysy tonysy requested a review from Mor-Li July 9, 2025 15:13
Copy link
Collaborator

@Mor-Li Mor-Li left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for spotting this. I didn’t realize the CLI args in the docs were incorrect 😂 — appreciate your fix!

@blueternalness
Copy link
Contributor Author

Thanks for spotting this. I didn’t realize the CLI args in the docs were incorrect 😂 — appreciate your fix!

Thanks for the review! But seems we need one more approval to merge this change. @MaiziXiao @tonysy Would check it?

Copy link
Collaborator

@tonysy tonysy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tonysy tonysy merged commit 8530b4c into open-compass:main Jul 14, 2025
3 checks passed
zyc140345 pushed a commit to zyc140345/opencompass that referenced this pull request Oct 23, 2025
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.

4 participants