docs: provide more usage and docs in docstring

[codacy-production[bot]]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +0.00% (target: -5.00%)	:white_check_mark: ∅

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (50efbff02aac78162acf49f48c64721ef5e88e3a) | 1772 | 1716 | 96.84% | | | Head commit (ada8e27a603e9ec8aeae73c5908bad80df3cf2d8) | 1772 (+0) | 1716 (+0) | 96.84% (**+0.00%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#120) | 0 | 0 | **∅ (not applicable)** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[codecov-commenter]

Codecov Report

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

Project coverage is 96.61%. Comparing base (50efbff) to head (ada8e27).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #120 +/- ## ======================================= Coverage 96.61% 96.61% ======================================= Files 16 16 Lines 1833 1833 ======================================= Hits 1771 1771 Misses 45 45 Partials 17 17 ```

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