settle on a docstring format and update all docstrings

[bwheelz36]

As discussed in #425.

Suggest using the numpy format, and integrating pydocstyle into test framework

TODO:

• Update constraint.py Update docs & linting for constraints.py, target_space.py #440
• Update logger.py Replace custom colour implementation, add docs for logger.py, util.py #435
• Update util.py Replace custom colour implementation, add docs for logger.py, util.py #435
• Update domain_reduction.py bounds_transformer could bypass global_bounds due to the test logic within _trim function in domain_reduction.py #441
• Update observer.py Update various docstrings, add workflow to check docstrings #445
• Update bayesian_optimization.pyUpdate various docstrings, add workflow to check docstrings #445
• Update event.py Update various docstrings, add workflow to check docstrings #445
• Update target_space.py Update docs & linting for constraints.py, target_space.py #440
• Integrate pydocstyle into testing. Update various docstrings, add workflow to check docstrings #445
• Use numpydoc

[bwheelz36]

this will probably be helpful too:
https://github.com/dadadel/pyment

[till-m]

numpy format

That would be according to this, I assume? If yes, that looks good to me!

[till-m]

(moved todo's to top post)

[till-m]

I have started doing some work on this. I also ran pylint over the codebase in parallel and started fixing some of code smells it reports. Since this is a rather large undertaking I would suggest proceeding in the following way:

• We fork the main branch to a separate branch in this project called something along the lines of docstring-overhaul or similar.
• We successively process the docstrings of each file and after finishing 1-3 files open a pull request to the docstring-overhaul branch
• After all files have been processed, we merge the docstring-overhaul branch into master.

This will make the entire thing more granular and not result in a 4000 lines PR that needs to be reviewed. Any thoughts or objections?

[bwheelz36]

Great work.
Honestly, not sure how much I will be able to help. I'm pretty busy with my new job. However the process sounds good :-)