Skip to content

Commit 3c5b00a

Browse files
authored
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)
1 parent d07b756 commit 3c5b00a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

mkdocs/docs/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,10 @@ We follow modern C++ best practices:
7373
- **C++23 Standard**: Use C++23 features where appropriate
7474
- **Naming Conventions**:
7575
- Classes: `PascalCase` (e.g., `TableScanBuilder`)
76-
- Functions: `snake_case` (e.g., `find_field_by_name`)
76+
- Functions/Methods: `PascalCase` (e.g., `CreateNamespace`, `ExtractYear`)
77+
- Trivial getters: `snake_case` (e.g., `name()`, `type_id()`, `is_primitive()`)
7778
- Variables: `snake_case` (e.g., `file_io`)
78-
- Constants: `UPPER_SNAKE_CASE` (e.g., `MAX_RETRIES`)
79+
- Constants: `k` prefix with `PascalCase` (e.g., `kHeaderContentType`, `kMaxPrecision`)
7980
- **Memory Management**: Prefer smart pointers (`std::unique_ptr`, `std::shared_ptr`)
8081
- **Error Handling**: Use `Result<T>` types for error propagation
8182
- **Documentation**: Use Doxygen-style comments for public APIs

0 commit comments

Comments
 (0)