Mercurial > libervia-backend
diff doc/developer.rst @ 4037:524856bd7b19
massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.
However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.
To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.
This is a massive change, and may result in some bugs.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 08 Apr 2023 13:54:42 +0200 |
| parents | 432aaba0d7fe |
| children | d6837db456fd |
line wrap: on
line diff
--- a/doc/developer.rst Fri Apr 07 15:18:39 2023 +0200 +++ b/doc/developer.rst Sat Apr 08 13:54:42 2023 +0200 @@ -60,9 +60,9 @@ analysers are checked, and the first one matching is used to determine if the node must be synchronised or not. -Analysers can be registered by any plugins using ``registerAnalyser`` method: +Analysers can be registered by any plugins using ``register_analyser`` method: -.. automethod:: sat.plugins.plugin_pubsub_cache.PubsubCache.registerAnalyser +.. automethod:: sat.plugins.plugin_pubsub_cache.PubsubCache.register_analyser If no analyser is found, ``to_sync`` is false, or an error happens during the caching, the node won't be synchronised and the pubsub service will always be requested.