use napoleon style docstrings

[williballenthin]

https://pypi.org/project/sphinxcontrib-napoleon/

[RahulSankhla312]

@williballenthin Could you please explain more about this issue ?

[williballenthin]

this issue tracks the idea of using the doctoring style linked above throughout the code base. to close the issue, the contributor would review the entire floss codebase and fix any violations, migrating from the old style to the napoleon style.

note that we'd also prefer to use type annotations when possible, keeping these out of the docstring.

[RahulSankhla312]

@williballenthin Should i do this type of napolean style to the whole codebase ?

[williballenthin]

please use the napoleon style, which is more like

args:
  foo: the foo thing
  bar: a bar for use

returns: xyz 

[RahulSankhla312]

Will like this be okay ? @williballenthin

[williballenthin]

looks great!

[RahulSankhla312]

@williballenthin Sure ill make the changes in the whole codebase.

[RahulSankhla312]

#979 Please review this PR
@mr-tz @williballenthin