Add docstrings to every function and class

[ZeroCool940711]

This pull request adds docstrings to every function and class in the codebase, providing information on how they work and how they should be used.

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[codecov]

Codecov Report

Attention: Patch coverage is 88.67925% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 81.31%. Comparing base (2a9626b) to head (fb7a10c).
Report is 35 commits behind head on main.

Files	Patch %	Lines
src/whoosh/filedb/filestore.py	33.33%	4 Missing ⚠️
src/whoosh/codec/whoosh3.py	88.88%	0 Missing and 1 partial ⚠️
src/whoosh/fields.py	88.88%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #73      +/-   ##
==========================================
+ Coverage   81.19%   81.31%   +0.12%     
==========================================
  Files         132      132              
  Lines       29299    29282      -17     
  Branches     5044     5020      -24     
==========================================
+ Hits        23789    23812      +23     
+ Misses       4641     4620      -21     
+ Partials      869      850      -19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

This PR is stale because it has been 60 days with no activity. This PR will be automatically closed within 7 days if there is no further activity.

[github-actions]

This PR was closed because it has been stalled for some time with no activity.