search

dadadel / pyment

Format and convert Python docstrings and generates patches
GNU General Public License v3.0
905 stars 62 forks source link

Please add example on how to specify output format #102

Closed UGuntupalli closed 3 years ago

UGuntupalli commented 3 years ago

Hello, Thanks for the work in putting this great package together. I just came across it today and I really like it. I have a python project where all my docstrings are restructured text format. I was unable to find an example that shows how to specify the output format for the docstring conversion. Could you kindly share an example ?

Thanks

dkdndes commented 3 years ago

Please read the documentation, the parameter is

-o style, --output style

the style options are explained here - output_style:

javadoc, reST, numpydoc, google, groups
UGuntupalli commented 3 years ago

@dkdndes, Peter, thank you for pointing me in the right direction. Humble suggestion, you are welcome to ignore is, the documentation seems to be hidden away somewhere that it is not obvious. Additionally, the quick start guide and example is what anyone who learns about pyment would first land on. So, my request would be to expand the example that is on the homepage to show how the output format can be specified to a desired format because that is the primary function the package is designed for.

Thank you once again