Align docstrings to hf guidelines
See https://github.com/huggingface/datasets-server/pull/2338#issuecomment-1909765283 for previous context.
This non-critical PR tries to align the datasets-server current docstring to HF guidelines (See https://github.com/huggingface/doc-builder for most details).
Changes:
- Remove `:obj:` notation - See internal https://www.notion.so/huggingface2/Documentation-926791574d274a5194cc83699c4a238e
- Remove `Raises the following errors` and `tip` - See https://github.com/huggingface/doc-builder#raises
- Move `Raises` before `Return` for functions - See https://github.com/huggingface/doc-builder#raises
- Optional parameters start and end with `*`- See https://github.com/huggingface/doc-builder#parmeter-typing-and-default-value
- `Attributes` in classes start and end with  `**` - See https://github.com/huggingface/doc-builder#attributes
- Args type start and end with ` - See https://github.com/huggingface/doc-builder#arguments
- Remove `required` from args since it is not needed - See https://github.com/huggingface/doc-builder#arguments
- Remove `Defaults to None` See https://github.com/huggingface/doc-builder#parmeter-typing-and-default-value 
- Remove `Return none`
- Align Returns type https://github.com/huggingface/doc-builder#returns
- Align `Raises`  See https://github.com/huggingface/doc-builder/#internal-link-to-object and https://github.com/huggingface/doc-builder/#raises 
- In workers, align step name in the doc header and first log message
Align docstrings to hf guidelines: See https://github.com/huggingface/datasets-server/pull/2338#issuecomment-1909765283 for previous context.
This non-critical PR tries to align the datasets-server current docstring to HF guidelines (See https://github.com/huggingface/doc-builder for most details).
Changes:
- Remove `:obj:` notation - See internal https://www.notion.so/huggingface2/Documentation-926791574d274a5194cc83699c4a238e
- Remove `Raises the following errors` and `tip` - See https://github.com/huggingface/doc-builder#raises
- Move `Raises` before `Return` for functions - See https://github.com/huggingface/doc-builder#raises
- Optional parameters start and end with `*`- See https://github.com/huggingface/doc-builder#parmeter-typing-and-default-value
- `Attributes` in classes start and end with  `**` - See https://github.com/huggingface/doc-builder#attributes
- Args type start and end with ` - See https://github.com/huggingface/doc-builder#arguments
- Remove `required` from args since it is not needed - See https://github.com/huggingface/doc-builder#arguments
- Remove `Defaults to None` See https://github.com/huggingface/doc-builder#parmeter-typing-and-default-value 
- Remove `Return none`
- Align Returns type https://github.com/huggingface/doc-builder#returns
- Align `Raises`  See https://github.com/huggingface/doc-builder/#internal-link-to-object and https://github.com/huggingface/doc-builder/#raises 
- In workers, align step name in the doc header and first log message