Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

:raises in reST is incorrectly parsed #19

Closed
inirudebwoy opened this issue Aug 6, 2015 · 2 comments
Closed

:raises in reST is incorrectly parsed #19

inirudebwoy opened this issue Aug 6, 2015 · 2 comments

Comments

@inirudebwoy
Copy link
Contributor

Hi,

This is my docstring:

        """
        :raises requests.exceptions.HTTPError: on response error from server
        :raises ValueError: on incorrect JSON

        """

This is patch produced by pyment:

-        """
-        :raises requests.exceptions.HTTPError: on response error from server
+        :raises requests: exceptions.HTTPError: on response error from server
         :raises ValueError: on incorrect JSON

         """

I have omitted parts not relevant for this issue. Returned class is sliced after first "."(dot).
Line should not be altered in my opinion at all.
@dadadel
Copy link
Owner

dadadel commented Aug 15, 2015

Thanks for reporting. That's right the line shouldn't be altered. I will fix that asap.

inirudebwoy added a commit to inirudebwoy/pyment that referenced this issue Dec 31, 2015
@inirudebwoy
Fix ":raises in reST is incorrectly parsed dadadel#19"
2be54a1 
Name of the documented exception only was accepting class name.
Module had been parsed incorrectly,
see dadadel#19
@inirudebwoy inirudebwoy mentioned this issue Dec 31, 2015
Merged
dadadel added a commit that referenced this issue Jun 9, 2016
@dadadel
Merge pull request #23 from inirudebwoy/fix_raises
e7c4ff9 
Fix issue #19 : raises in reST docs
@dadadel
Copy link
Owner

dadadel commented Jun 9, 2016

Thank you @inirudebwoy for your help and sorry for my long time to accept your request.

@dadadel dadadel closed this as completed Jun 9, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@inirudebwoy @dadadel