Align docstrings to hf guidelines (#2351)
* Remove :obj:
* Align raises and return at the end
* Align optional types
* Align attributes
* align args
* Align args
* Align Defaults to None
* Remove returns None for voids
* Align return type
* Align Raises
* Align comment headers and logging in workers
* Align raises
* (`StrPath`)
* fix style
* Align Raises with []
* Apply @severo suggestions from code review
Co-authored-by: Sylvain Lesage <sylvain.lesage@huggingface.co>
* add link to guidelines and fix style
---------
Co-authored-by: Sylvain Lesage <sylvain.lesage@huggingface.co>
