97 improve docstrings for public functions

[codecov[bot]]

Codecov Report

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

Project coverage is 88.06%. Comparing base (36ed77a) to head (6d040ac).

:exclamation: Current head 6d040ac differs from pull request most recent head fd030bf

Please upload reports for the commit fd030bf to get more accurate results.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #98 +/- ## ======================================= Coverage 88.06% 88.06% ======================================= Files 9 9 Lines 1156 1156 ======================================= Hits 1018 1018 Misses 138 138 ```

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

[sonarcloud[bot]]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud