diff --git a/README.md b/README.md index 87a27a0..b0cee0c 100644 --- a/README.md +++ b/README.md @@ -315,6 +315,15 @@ From `1.0.0` on, the guarantee below is the written one and holds: Anything not in the API table, and anything with a leading underscore, is internal either way. +## Naming + +The API is camelCase, including in Python where PEP 8 would ask for +snake_case. That is deliberate rather than an oversight: camelCase is the +naming convention used across this author's projects, and consistency across +them is valued over each language's own idiom. The one exception is the methods +Nemo itself calls (`update_file_info`, `get_columns`, `get_file_items` and +friends), which have to keep the names the file manager looks for. + ## Tested on Linux Mint 22.2 (Zara), Cinnamon 6.4.14, Nemo 6.4.5, python-nemo 6.4.0, diff --git a/nemoRepoCore/__init__.py b/nemoRepoCore/__init__.py index 4e118f5..83d285b 100644 --- a/nemoRepoCore/__init__.py +++ b/nemoRepoCore/__init__.py @@ -38,6 +38,11 @@ Stability policy for everything listed in __all__: may reshape anything. * Names not in __all__, and anything with a leading underscore, are internal and may change in any release. + +The public names are camelCase rather than PEP 8 snake_case on purpose: it is +the naming convention used across this author's projects. Only the methods +Nemo itself calls (update_file_info, get_columns and friends) keep the names +the file manager requires. """ from .Config import Config, coreConfig, coreDefaults, defaultConfigPath, legacyConfigPath