docs: add detailed docstrings to DBInfo methods and classes

[bernhardkaindl]

Follow-up of #2064, just as a demonstration for showing other handy tools besides ChatGPT.

This is mainly to demonstrate some tools that can aid in generating docstrings.

From the commit message:

• Corrected a typo in the DBInfo class description.
• Added detailed docstrings to various methods and properties in the DBInfo class
• Added class-level docstrings to subclasses of DBInfo to describe their purpose.
• Enhanced the FindAnvioDBs class docstring by adding missing parameters.
• Improved the listdir and walk methods in it with detailed docstrings.

Background infos:

• Human brain cells were used to establish the indented docstring formatting by looking for existing docstrings in the project writing examples based on them and by opening other files in VS Code that already use this docstring parameter format for GitHub Copilot to use as examples to produce the expected formatting.
  • Brain cells were also used to check the validity of the generated docstrings and to find missing/undocumented parameters and a short docstring that could be improved.
• Typos found using in VS Code using the Code Spell Checker plugin.
• Docstrings generated interactively in VS Code, mostly using tab completion using GitHub Copilot
  • and to a lesser extent using the VS Code Sourcery Plugin
• Review of the changes and initial changelog generated using VS Code Sourcery Plugin as well.
  • The review by Sourcery was very accurate and led to further fixes.
  • The changelog generated as the 1st part of the review of the changes was very detailed, so I trimmed it to be a more brief bullet-point list.

[meren]

This is very helpful, @bernhardkaindl! Thank you very much. I will merge this, but since now we are officially merging your code to the database, would you please consider sending another PR

Thanks again for the PR you've sent in. Would you please consider sending a PR for this file in the anvi’o repository after adding an entry for yourself:

https://github.com/merenlab/anvio/blob/master/anvio/data/misc/PEOPLE/DEVELOPERS.yaml

Luckily the DEVELOPERS.yaml file has multiple examples to use as template, and the only additional thing is a 900x900px profile photo of yours with the file name that matches to your GitHub username under the AVATARS directory.

More info is here:

https://github.com/merenlab/anvio/tree/master/anvio/data/misc/PEOPLE

These data are rendered and then appear on this page:

https://anvio.org/people/

Thank you for your consideration!