This is an automated email from the ASF dual-hosted git repository.
gangwu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-cpp.git
The following commit(s) were added to refs/heads/main by this push:
new 3c5b00a0 docs: Fix naming conventions documentation (#504)
3c5b00a0 is described below
commit 3c5b00a02ca686ad0282c3671684270ce07a5a56
Author: Junwang Zhao <[email protected]>
AuthorDate: Sun Jan 11 23:26:07 2026 +0800
docs: Fix naming conventions documentation (#504)
- Update Functions/Methods to use PascalCase (was incorrectly documented
as snake_case)
- Add note about trivial getters using snake_case (e.g., name(),
type_id())
- Update Constants to use k prefix with PascalCase (was incorrectly
documented as UPPER_SNAKE_CASE)
---
mkdocs/docs/index.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md
index dd5d098f..5df1a650 100644
--- a/mkdocs/docs/index.md
+++ b/mkdocs/docs/index.md
@@ -73,9 +73,10 @@ We follow modern C++ best practices:
- **C++23 Standard**: Use C++23 features where appropriate
- **Naming Conventions**:
- Classes: `PascalCase` (e.g., `TableScanBuilder`)
- - Functions: `snake_case` (e.g., `find_field_by_name`)
+ - Functions/Methods: `PascalCase` (e.g., `CreateNamespace`, `ExtractYear`)
+ - Trivial getters: `snake_case` (e.g., `name()`, `type_id()`,
`is_primitive()`)
- Variables: `snake_case` (e.g., `file_io`)
- - Constants: `UPPER_SNAKE_CASE` (e.g., `MAX_RETRIES`)
+ - Constants: `k` prefix with `PascalCase` (e.g., `kHeaderContentType`,
`kMaxPrecision`)
- **Memory Management**: Prefer smart pointers (`std::unique_ptr`,
`std::shared_ptr`)
- **Error Handling**: Use `Result<T>` types for error propagation
- **Documentation**: Use Doxygen-style comments for public APIs
