tr4nt0r / pyloadapi

Simple wrapper for pyLoad's API.
https://tr4nt0r.github.io/pyloadapi/
MIT License
0 stars 0 forks source link

Improve docstrings in PyLoadAPI class #30

Closed tr4nt0r closed 3 months ago

tr4nt0r commented 3 months ago

Enhanced docstrings for methods in the PyLoadAPI class to provide clear descriptions of their functionalities, return types, raised exceptions, and usage examples. Each method now includes detailed explanations of its purpose, what it returns, and the specific exceptions it may raise during operation. These updates improve code readability and facilitate easier maintenance and usage of the pyload_api module.

Changes include:

These updates adhere to numpy style for documenting Python code.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.83%. Comparing base (bcf8503) to head (6eebe3d).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #30 +/- ## ======================================= Coverage 96.83% 96.83% ======================================= Files 4 4 Lines 158 158 ======================================= Hits 153 153 Misses 5 5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.