Skip to content

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

Open
joshlk wants to merge 1 commit intoneithere:masterfrom
joshlk:feature/docstring_parsing
Open

Decorator to parse a Sphinx docstring to obtain arg description#109
joshlk wants to merge 1 commit intoneithere:masterfrom
joshlk:feature/docstring_parsing

Conversation

@joshlk
Copy link

@joshlk joshlk commented Aug 11, 2016

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
Copy link

coveralls commented Aug 11, 2016

Coverage Status

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

@neithere
Copy link
Owner

neithere commented Aug 26, 2016

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
Copy link
Author

joshlk commented Sep 5, 2016

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants