Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make all the docstrings PEP 257 compliant #2028

Merged
merged 69 commits into from
Jul 2, 2024
Merged

Make all the docstrings PEP 257 compliant #2028

merged 69 commits into from
Jul 2, 2024

Commits on Jul 2, 2024

  1. Updates to satsify pep257 violations

    @radez @webknjaz
    radez authored and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    469750e View commit details
    Browse the repository at this point in the history

  2. 🧪🔥 Drop separate pep257 linting check

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    ba13137 View commit details
    Browse the repository at this point in the history

  3. Rewrite compat dopcstrings

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    f076a71 View commit details
    Browse the repository at this point in the history

  4. Make dispatch module docstrings more accurate

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    e30d3ee View commit details
    Browse the repository at this point in the history

  5. Drop a redundand pass node from the error module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    0295e06 View commit details
    Browse the repository at this point in the history

  6. Format the closing jdocstring quotes in dispatch mod

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    208880d View commit details
    Browse the repository at this point in the history

  7. Rephrase a function docstring in dispatch

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c8ade18 View commit details
    Browse the repository at this point in the history

  8. Fix the spelling of CherryPy in logging mod

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    980af9b View commit details
    Browse the repository at this point in the history

  9. Normalize the http error mod docstrings

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    8373831 View commit details
    Browse the repository at this point in the history

  10. Improve the look of the logging module docstrings

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    fe8867d View commit details
    Browse the repository at this point in the history

  11. Improcve the mod_python integration docstrings

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    368a913 View commit details
    Browse the repository at this point in the history

  12. Improve docstrings for request body handler

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    e04421e View commit details
    Browse the repository at this point in the history

  13. Improve the docstrings in the request module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    dc9271d View commit details
    Browse the repository at this point in the history

  14. Split the long line in a docstring in request mod

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    73619fa View commit details
    Browse the repository at this point in the history

  15. Improve docstrings in the tools module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    b681368 View commit details
    Browse the repository at this point in the history

  16. Update cherrypy/lib/auth_digest.py 

    Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
    @radez @webknjaz
    radez and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    4418bb9 View commit details
    Browse the repository at this point in the history

  17. Update cherrypy/lib/auth_digest.py 

    Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
    @radez @webknjaz
    radez and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c3421b4 View commit details
    Browse the repository at this point in the history

  18. Update cherrypy/lib/auth_digest.py 

    Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
    @radez @webknjaz
    radez and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    3d83e72 View commit details
    Browse the repository at this point in the history

  19. Update cherrypy/lib/auth_digest.py 

    Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
    @radez @webknjaz
    radez and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    f04daa0 View commit details
    Browse the repository at this point in the history

  20. Update cherrypy/lib/auth_digest.py 

    Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
    @radez @webknjaz
    radez and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    9eb06d7 View commit details
    Browse the repository at this point in the history

  21. Update cherrypy/lib/auth_digest.py 

    Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
    @radez @webknjaz
    radez and webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    2c0688d View commit details
    Browse the repository at this point in the history

  22. Clarify MemoryCache initializer docstring

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    6962e42 View commit details
    Browse the repository at this point in the history

  23. Clarify cherrypy.lib.caching docstring

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    8182840 View commit details
    Browse the repository at this point in the history

  24. Clarify docstrings in cherrypy.lib.covercp module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    ea6e6c9 View commit details
    Browse the repository at this point in the history

  25. Clarify docstrings in cherrypy.lib.cpstats module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    83f2735 View commit details
    Browse the repository at this point in the history

  26. Clarify docstrings in cherrypy.lib.cptools module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    d8ece8b View commit details
    Browse the repository at this point in the history

  27. Clarify docstrings in cherrypy.lib.encoding module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    8e184c9 View commit details
    Browse the repository at this point in the history

  28. Clarify docstrings in cherrypy.lib.gctools module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    342b01a View commit details
    Browse the repository at this point in the history

  29. Clarify docstrings in cherrypy.lib.httputil module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    25a1bef View commit details
    Browse the repository at this point in the history

  30. Clarify docstrings in cherrypy.lib.jsontools module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    ae3e9df View commit details
    Browse the repository at this point in the history

  31. Clarify docstrings in cherrypy.lib.locking module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    dde7887 View commit details
    Browse the repository at this point in the history

  32. Clarify docstrings in cherrypy._cprequest module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    4dabb1b View commit details
    Browse the repository at this point in the history

  33. Clarify docstrings in cherrypy.lib.profiler module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    b616cc1 View commit details
    Browse the repository at this point in the history

  34. Clarify docstrings in cherrypy.lib.reprconf module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    af4f8a5 View commit details
    Browse the repository at this point in the history

  35. Clarify docstrings in cherrypy.lib.sessions module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    b588aa5 View commit details
    Browse the repository at this point in the history

  36. Clarify docstrings in cherrypy.process.plugins module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c262c0e View commit details
    Browse the repository at this point in the history

  37. Clarify docstrings in cherrypy.process.servers module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    18d8f71 View commit details
    Browse the repository at this point in the history

  38. Clarify docstrings in cherrypy.process.win32 module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    9a9c743 View commit details
    Browse the repository at this point in the history

  39. Clarify docstrings in cherrypy.test package

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    7ec3fd7 View commit details
    Browse the repository at this point in the history

  40. fixup! cherrypy/test/__init__.py

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c0d3e28 View commit details
    Browse the repository at this point in the history

  41. fixup! cherrypy/lib/sessions.py

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    b68ca43 View commit details
    Browse the repository at this point in the history

  42. Clarify docstrings in cherrypy.tutorial package

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    1285fa4 View commit details
    Browse the repository at this point in the history

  43. Clarify docstrings in cherrypy.test.webtest module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    5a12861 View commit details
    Browse the repository at this point in the history

  44. fixup! cherrypy/test/webtest.py

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    bab8974 View commit details
    Browse the repository at this point in the history

  45. Clarify docstrings in cherrypy.tutorial.tut01_helloworld module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    d0c0d6d View commit details
    Browse the repository at this point in the history

  46. Clarify docstrings in cherrypy.tutorial.tut03_get_and_post module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    cca0410 View commit details
    Browse the repository at this point in the history

  47. Clarify docstrings in cherrypy.tutorial.tut02_expose_methods module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c0cff17 View commit details
    Browse the repository at this point in the history

  48. Clarify docstrings in cherrypy.tutorial.tut04_complex_site module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    4244c61 View commit details
    Browse the repository at this point in the history

  49. Clarify docstrings in cherrypy.tutorial.tut05_derived_objects module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    4dfd6f9 View commit details
    Browse the repository at this point in the history

  50. Clarify docstrings in cherrypy.tutorial.tut06_default_method module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    7deb828 View commit details
    Browse the repository at this point in the history

  51. Clarify docstrings in cherrypy.tutorial.tut07_sessions module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    3a20d16 View commit details
    Browse the repository at this point in the history

  52. Clarify docstrings in cherrypy.tutorial.tut08_generators_and_yield … 

    …module
    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    e1bf5b8 View commit details
    Browse the repository at this point in the history

  53. Clarify docstrings in cherrypy.tutorial.tut09_files module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    9305612 View commit details
    Browse the repository at this point in the history

  54. Clarify docstrings in cherrypy.tutorial.tut10_http_errors module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    6f9436d View commit details
    Browse the repository at this point in the history

  55. Clarify docstrings in cherrypy.test.modwsgi module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    2da3f53 View commit details
    Browse the repository at this point in the history

  56. Clarify docstrings in cherrypy.test.sessiondemo module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    0242ec4 View commit details
    Browse the repository at this point in the history

  57. Clarify docstrings in cherrypy.test.modpy module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c4f3906 View commit details
    Browse the repository at this point in the history

  58. Clarify docstrings in cherrypy.test.modfcgid module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    8a7d37d View commit details
    Browse the repository at this point in the history

  59. Clarify docstrings in cherrypy.test.modfastcgi module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    d90ca1d View commit details
    Browse the repository at this point in the history

  60. Clarify docstrings in cherrypy.test.logtest module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    43b172c View commit details
    Browse the repository at this point in the history

  61. Clarify docstrings in cherrypy.test.checkerdemo module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    4a82cbb View commit details
    Browse the repository at this point in the history

  62. Clarify docstrings in cherrypy.test.helper module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    19528b1 View commit details
    Browse the repository at this point in the history

  63. Clarify docstrings in cherrypy.test.benchmark module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    2b1280a View commit details
    Browse the repository at this point in the history

  64. Clarify docstrings in cherrypy.test._test_decorators module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    5ea0c97 View commit details
    Browse the repository at this point in the history

  65. Clarify docstrings in cherrypy.test._test_states_demo module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    248331e View commit details
    Browse the repository at this point in the history

  66. Clarify docstrings in cherrypy.lib.auth_digest module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    71951cb View commit details
    Browse the repository at this point in the history

  67. Clarify docstrings in cherrypy._cpwsgi module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    98175fb View commit details
    Browse the repository at this point in the history

  68. fixup! cherrypy/_cpwsgi.py

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    b0b70a9 View commit details
    Browse the repository at this point in the history

  69. Clarify docstrings in cherrypy.lib.headers module

    @webknjaz
    webknjaz committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    a234f69 View commit details
    Browse the repository at this point in the history