Mercurial > libervia-backend
annotate doc/contributing/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 | e65395e5f649 |
children |
rev | line source |
---|---|
3645 | 1 .. _contributing: |
3430
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 |
3645 | 3 ============ |
4 contributing | |
5 ============ | |
3430
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 This part of the documentation is for people willing to contribute to the development of |
3505 | 8 Libervia and its ecosystem, it is not needed to read this if you only plan to use the |
3430
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 software. |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 .. toctree:: |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 :glob: |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 :maxdepth: 2 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 testing |