Decorator to parse a Sphinx docstring to obtain arg description

neithere / argh

An argparse wrapper that doesn't make you say "argh" each time you deal with it.

http://argh.rtfd.org

GNU Lesser General Public License v3.0

369 stars 56 forks source link

Decorator to parse a Sphinx docstring to obtain arg description #109

Open joshlk opened 8 years ago

joshlk commented 8 years ago

PR that adds a decorator which parses a function's Sphinx docstring and adds type and description information to the parser.

It hasn't got tests yet but wanted it out there to see if there is an appetite to merge in.

coveralls commented 8 years ago

Coverage decreased (-13.2%) to 80.424% when pulling 4c501102299fa64ecb9d74fb1af9428eb7b069dd on joshlk:feature/docstring_parsing into 4fcd062ffba82f5603c411146c29612949728189 on neithere:master.

neithere commented 8 years ago

Hi Josh,

Thank you for the PR! I've finally found some time to take a look at it. Of course I'd ask for unit tests and some refactoring in the new module in order to merge it, but as a demo it looks fantastic. I'd really like to drop the non-KISS arg decorators in my code in favour of this one. Do you plan to work a bit more on this soon?

P.S.: please merge master first in case you are going to continue, I've just fixed Travis builds there.

joshlk commented 8 years ago

Hi, thanks. What refactoring did you have in mind? What do you mean by a non-KISS decorator?