Skip to content

Document American spelling for new identifiers; keep Analyse* APIs #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tameware merged 8 commits into from
Sep 16, 2026
+9 −2
Merged

Document American spelling for new identifiers; keep Analyse* APIs #383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a5a6882
Prefer American spelling in non-API identifiers and filenames.
tameware Sep 15, 2026
0d148fb
Document AnalysePlayBin as the Bazel target for analyze_play_bin.
tameware Sep 15, 2026
528d499
Revert "Document AnalysePlayBin as the Bazel target for analyze_play_…
tameware Sep 15, 2026
96e9ebf
Revert "Prefer American spelling in non-API identifiers and filenames."
tameware Sep 15, 2026
ce0d00b
Revert play-analysis identifier Americanization.
tameware Sep 15, 2026
cacf06d
Document American spelling for new identifiers, keep legacy APIs.
tameware Sep 15, 2026
7df9bc7
Keep American Analyze in AnalysePlay* @brief prose.
tameware Sep 15, 2026
8ec8af0
Keep American Analyze in Python Analyse* docstrings.
tameware Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/instructions/cpp.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ This project follows a consistent modern C++ style, inspired by Google/LLVM with

## Naming

Prefer American spelling in identifiers (files, functions, variables) for new
code and for anything not tied to an existing API. Leave legacy public-API
names that already use British spelling unchanged (for example `AnalysePlay*`).

### Types
- **PascalCase**
- Examples: `FixedArray`, `ErrorCode`, `SimulationRunner`
Expand Down
5 changes: 4 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@ Follow .github/instructions/cpp.instructions.md

Follow .github/instructions/cpp.instructions.md

Prefer American spelling in file, function, and variable names for new code
and for anything not tied to an existing API.
Comment thread
tameware marked this conversation as resolved.

Exceptions:
- Match existing external or legacy APIs (for example, public C API names and types that already use a different style).
- Match existing external or legacy APIs (for example, public C API names and types that already use a different style, such as `AnalysePlay*`).
- Do not rename unrelated legacy identifiers in the same change unless the task requires it.

# Test-driven development
Expand Down
2 changes: 1 addition & 1 deletion examples/README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Run an example:

Available examples:
- analyse_all_plays_bin, analyse_all_plays_pbn
- analyse_play_bin, analyse_play_pbn
- AnalysePlayBin (source `analyse_play_bin.cpp`), analyse_play_pbn
- calc_all_tables, calc_all_tables_pbn
- calc_dd_table, calc_dd_table_pbn
- dd_table_for_deal (C++; Python: //python/examples:dd_table_for_deal; .NET: dotnet/DdTableForDeal)
Expand Down