[API Freeze] Remove camelCase module functions before 1.0 #304

New issue

Closed

opened 2026-04-10 01:14:44 +00:00 by john · 0 comments

john commented

2026-04-10 01:14:44 +00:00

Owner

Context

The API consistency audit (docs/api-audit-2026-04.md) identified 4 module-level functions using camelCase while the entire rest of the API uses snake_case:

mcrfpy.setScale() → deprecated anyway (use Window.resolution)
mcrfpy.findAll() → find_all() alias added
mcrfpy.getMetrics() → get_metrics() alias added
mcrfpy.setDevConsole() → set_dev_console() alias added

Snake_case aliases were added in the audit commit. The camelCase versions should be removed in the 1.0 breaking-changes pass.

Action Items

Remove setScale from mcrfpyMethods[] (already deprecated)
Remove findAll from mcrfpyMethods[]
Remove getMetrics from mcrfpyMethods[]
Remove setDevConsole from mcrfpyMethods[]
Update any scripts/tests that use the old names
Update documentation

Files

src/McRFPy_API.cpp (method table)

## Context The API consistency audit (docs/api-audit-2026-04.md) identified 4 module-level functions using camelCase while the entire rest of the API uses snake_case: - `mcrfpy.setScale()` → deprecated anyway (use `Window.resolution`) - `mcrfpy.findAll()` → `find_all()` alias added - `mcrfpy.getMetrics()` → `get_metrics()` alias added - `mcrfpy.setDevConsole()` → `set_dev_console()` alias added Snake_case aliases were added in the audit commit. The camelCase versions should be **removed** in the 1.0 breaking-changes pass. ## Action Items - [ ] Remove `setScale` from `mcrfpyMethods[]` (already deprecated) - [ ] Remove `findAll` from `mcrfpyMethods[]` - [ ] Remove `getMetrics` from `mcrfpyMethods[]` - [ ] Remove `setDevConsole` from `mcrfpyMethods[]` - [ ] Update any scripts/tests that use the old names - [ ] Update documentation ## Files - `src/McRFPy_API.cpp` (method table)