Skip to content

chore: fix small error in docs#2497

Merged
lemire merged 1 commit intosimdjson:masterfrom
0xflotus:patch-1
Oct 3, 2025
Merged

chore: fix small error in docs#2497
lemire merged 1 commit intosimdjson:masterfrom
0xflotus:patch-1

Conversation

@0xflotus
Copy link
Contributor

@0xflotus 0xflotus commented Oct 3, 2025

Short title (summary):

I fixed a small typo in the docs.

Description

  • What did you change and why? (1-3 sentences)
  • Issue reproduced / related issue: link the issue if relevant (e.g. Fix typo in title #123)

Type of change

  • Bug fix
  • New feature
  • Refactor / cleanup
  • Documentation / tests
  • Other (please describe):

How to verify / test

  • Add additional tests to verify bugs or new features.
  • If you claim performance gains, you should provide benchmark numbers using high quality benchmarking code.

Please read before contributing:

If you can, we recommend running our tests with the sanitizers turned on.
For non-Visual Studio users, it is as easy as doing:

cmake -B build -D SIMDJSON_SANITIZE=ON -D SIMDJSON_DEVELOPER_MODE=ON
cmake --build build
ctest --test-dir build

Our CI checks, among other things, for trailing whitespace. If a test fails for that reason,
use the "artifacts" button to download the artifact and inspect the problematic lines,
or run scripts/remove_trailing_whitespace.sh locally if you have a bash shell and sed.

Checklist before submitting

  • I added/updated tests covering my change (if applicable)
  • Code builds locally and passes my check
  • Documentation / README updated if needed
  • Commits are atomic and messages are clear
  • I linked the related issue (if applicable)

Final notes

  • For large PRs, prefer smaller incremental PRs or request staged review.

Thanks for the contribution!

@lemire lemire requested a review from Copilot October 3, 2025 13:54
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@lemire lemire merged commit a7f8fb7 into simdjson:master Oct 3, 2025
82 of 83 checks passed
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.

3 participants