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

Bug: Inproper display of type annotations in reference.md #5

Closed
radlfabs opened this issue Nov 5, 2023 · 1 comment
Closed

Bug: Inproper display of type annotations in reference.md #5

radlfabs opened this issue Nov 5, 2023 · 1 comment
Assignees
@radlfabs
Labels
bug Something isn't working

Comments

@radlfabs
Copy link
Owner

radlfabs commented Nov 5, 2023 •
edited

In Reference.md some type annotations are irregular parsed. This seems to be module related.
For some modules the types are not recognized at all and are parsed as part of the descriptions, i.e. displayed in the wrong column.
Working in interface.py, not working e.g. in results_handling.py.
Correct:
image
Incorrect:
image
@radlfabs radlfabs added the bug Something isn't working label Nov 5, 2023
@radlfabs radlfabs self-assigned this Nov 5, 2023
@radlfabs radlfabs changed the title Fix type annotations in docs Bug: Inproper display of type annotations in reference.md Nov 6, 2023
radlfabs added a commit that referenced this issue Nov 7, 2023
@radlfabs
fix bug where types were inproperly parsed to docs
a625a85 
#5 (comment)
@radlfabs
Copy link
Owner Author

radlfabs commented Nov 7, 2023

This has been fixed!

@radlfabs radlfabs closed this as completed Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@radlfabs radlfabs

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@radlfabs