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.

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

Parser doesn't parse types in reStructurted Text format #26

Open
LostInDarkMath opened this issue Aug 7, 2020 · 4 comments
Open

Parser doesn't parse types in reStructurted Text format #26

LostInDarkMath opened this issue Aug 7, 2020 · 4 comments

Comments

@LostInDarkMath
Copy link

My example, which I found Here:

"""Gets and prints the spreadsheet's header columns

:param file_loc: The file location of the spreadsheet
:type file_loc: str
:param print_cols: A flag used to print the columns to the console
    (default is False)
:type print_cols: bool
:returns: a list of strings representing the header columns
:rtype: list
"""

In I parse this using your code, alle types will be ignored: TypeName == None

Is this a bug in your code or is an error in the docstring?

@rr-
Copy link
Owner

rr- commented Aug 7, 2020

IIRC we use :param file_loc str: The file location of the spreadsheet syntax

@LostInDarkMath
Copy link
Author

Thank you for your quick answer.

Is there a chance, that a future version of your parser supports the syntax I mentioned above?

@rr-
Copy link
Owner

rr- commented Aug 7, 2020

I don't have capacity to work on it myself, but any PRs are encouraged and will be reviewed fast :)

@SamuelMarks
Copy link

@LostInDarkMath FYI - My parser supports proper type parsing for ReST. Still in alpha - https://github.com/SamuelMarks/doctrans

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants