Prefer American spelling in prose, docs, and comments - #378
Merged
Merged
Conversation
Leave legacy Analyse* API identifiers and matching filenames unchanged. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Restore the legacy Analyse* references and preserve the published documentation anchor before approval.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This PR standardizes British spellings to American English across documentation, comments, tests, and help text while preserving runtime behavior and legacy API filenames.
Changes:
- Updates prose, comments, release notes, and user-facing text.
- Requires restoring two legacy
Analyse*API references. - Requires preserving the published documentation anchor.
File summaries
| File | Summary |
|---|---|
specs/web.md |
Updated heading spelling. |
specs/wasm-emscripten.md |
Updated heading spelling. |
specs/transposition-table.md |
Updated behavior wording. |
specs/system-concurrency.md |
Updated behavior wording. |
specs/solver-context.md |
Updated behavior and initialization wording. |
specs/python-binding.md |
Updated analysis and behavior wording. |
specs/move-generation.md |
Updated optimization and categorization wording. |
specs/lookup-tables.md |
Updated heading spelling. |
specs/jni-ffm-binding.md |
Updated heading spelling. |
specs/heuristic-sorting.md |
Updated behavior wording. |
specs/examples-cli.md |
Updated behavior wording. |
specs/dotnet-binding.md |
Updated wording; restore the Analyse* API token. |
specs/dds-public-api.md |
Updated wording; restore the Analyse* API token. |
specs/constants-and-debug.md |
Updated behavior wording. |
specs/build-system.md |
Updated optimization wording. |
specs/ab-stats.md |
Updated heading spelling. |
specs/_template.md |
Updated template wording. |
SECURITY.md |
Updated modeling and recognition wording. |
python/tests/ci_windows_cppopts_test.py |
Updated comments and messages. |
python/src/bindings.cpp |
Updated documentation strings. |
library/tests/trans_table/trans_table_p_test.cpp |
Updated test comment. |
library/tests/system/max_threads_equivalence_test.cpp |
Updated test documentation. |
library/tests/system/configure_tt_api_test.cpp |
Updated test comments. |
library/tests/solve_board/analyse_play_consistency.cpp |
Updated test comment. |
library/tests/heuristic_sorting/dispatch_findex_test.cpp |
Updated test documentation. |
library/tests/fuzz/findings/README.md |
Updated finding descriptions. |
library/tests/deal_input_validation_test.cpp |
Updated test comments. |
library/src/trans_table/trans_table_p.hpp |
Updated API documentation. |
library/src/trans_table/trans_table_p.cpp |
Updated implementation comment. |
library/src/solver_context/solver_context.cpp |
Updated implementation comment. |
library/src/par_validate.hpp |
Updated API documentation. |
library/src/dds.cpp |
Updated implementation comment. |
library/src/calc_tables.cpp |
Updated implementation comments. |
jni/java/org/dds/ffm/DdsStatus.java |
Updated API documentation. |
jni/BUILD.bazel |
Updated build comment. |
docs/release_notes/release_v3_1_0.md |
Updated release-note wording. |
docs/dotnet_interface.md |
Updated initialization and honoring wording. |
doc/heuristic-sorting.md |
Updated prose spelling. |
doc/dll-description.md |
Updated heading and initialization wording; preserve the existing anchor. |
doc/dll-description.html |
Updated generated documentation text. |
CPPVARIABLES.bzl |
Updated build comment. |
ChangeLog |
Updated prose spelling. |
benchmarks/README.md |
Updated command description. |
benchmarks/dds_replay_main.cpp |
Updated CLI help text. |
Review details
Suppressed comments (1)
doc/dll-description.md:50
- Changing this heading also changes its generated fragment from
#double-dummy-value-analyser-functionsto#double-dummy-value-analyzer-functions, so existing links/bookmarks to the published documentation will no longer jump to the section. Preserve the old fragment as a compatibility alias in the Markdown source and regenerate this checked-in HTML.
### Double Dummy Value Analyzer Functions
- Files reviewed: 44/44 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Keep legacy symbol names in the specs and alias the previous analyser heading fragment so bookmarks still resolve. Co-authored-by: Cursor <cursoragent@cursor.com>
Collaborator
Author
|
Addressed the Copilot review:
Ready for another Copilot review. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The only final finding is a non-blocking documentation-consistency nit; the changes are prose-only and preserve legacy API identifiers and anchors.
Review details
Suppressed comments (1)
doc/dll-description.md:52
- This heading has parallel published copies in
doc/DLL-dds_x.htmanddoc/DLL-dds_x.mht, which still say “Double Dummy Value Analyser Functions” (for exampledoc/DLL-dds_x.htm:1628-1629). Updating only the Markdown and lowercase HTML copies leaves the documentation formats inconsistent with the stated American-spelling change; update the mirrored copies too, or explicitly exclude them from this scope.
### Double Dummy Value Analyzer Functions
- Files reviewed: 44/44 changed files
- Comments generated: 0 new
- Review effort level: Lite
Keep the published htm/mht heading copies consistent with the markdown and lowercase HTML documentation. Co-authored-by: Cursor <cursoragent@cursor.com>
Collaborator
Author
|
Addressed the follow-up documentation-consistency note:
Ready for another Copilot review. |
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
Update or explicitly exclude doc/Alg-dds_x.rtf, which still contains favoured.
Review details
Suppressed comments (1)
Previously missed (1) — in code that hasn't changed since the last review.
doc/heuristic-sorting.md:42
- The same heuristic-sorting sentence is also present in
doc/Alg-dds_x.rtfand still saysfavoured(line 731), so a documentation copy remains British-spelled even though this Markdown copy is changed tofavored. Please update the RTF counterpart, or explicitly exclude legacy RTF documents if that is intentional, to satisfy the stated cross-document scope.
- Files reviewed: 46/46 changed files
- Comments generated: 0 new
- Review effort level: Lite
Collaborator
Author
|
Alg-dds_x.rtf is historical. It should not be updated. |
tameware
added
the
Clean Copilot review
zzcgumn
approved these changes
Sep 14, 2026
This reverts commit 4d3b265.
Collaborator
Author
|
Rolled back the changes to |
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.
Summary
Analyse*API identifiers and matching filenames unchanged.Test plan
AnalysePlay*/AnalyseAllPlays*symbols and example/Bazel target names are unchangedMade with Cursor