Mercurial > libervia-backend
view doc/index.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 | 8f87ff449a34 |
| children | d6837db456fd |
line wrap: on
line source
====================== Libervia documentation ====================== Welcome to Libervia's documentation. You'll find here both end-user and developer documentations. Libervia is a Libre communication ecosystem based on XMPP standard. It allows you to do many things such as: - instant messaging - (micro)blogging - file sharing - managing photo albums - organizing/managing events - handling tasks - etc. It features many interfaces (desktop, mobile, web, command line, console), and is multi-platforms. You can follow this documentation to learn more on it, or join our official XMPP room at `sat@chat.jabberfr.org <xmpp:sat@chat.jabberfr.org?join>`_ (also available via a `web link <https://chat.jabberfr.org/converse.js/sat@chat.jabberfr.org>`_) .. toctree:: :caption: Contents: :maxdepth: 3 installation.rst overview.rst configuration.rst encryption.rst components.rst developer.rst /libervia-cli/index.rst /libervia-tui/index.rst /contributing/index.rst Indices and tables ================== * :ref:`genindex` * :ref:`search`