Mercurial > libervia-backend
view doc/_ext/docstring.py @ 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 | 62e81b1058f8 |
children |
line wrap: on
line source
#!/usr/bin/env python3 """Adapt Libervia docstring style to autodoc""" def process_docstring(app, what, name, obj, options, lines): lines[:] = [ l.replace("@param", ":param").replace("@raise", ":raises") for l in lines ] def setup(app): app.connect("autodoc-process-docstring", process_docstring) return { 'version': '0.1', 'parallel_read_safe': True, 'parallel_write_safe': True, }