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

Weird line overflow issues on readthedocs API #45

Open
taylorbell57 opened this issue Apr 19, 2024 · 1 comment
Open

Weird line overflow issues on readthedocs API #45

taylorbell57 opened this issue Apr 19, 2024 · 1 comment

Comments

@taylorbell57
Copy link
Contributor

There is something strange going on with the formatting of your API documentation on readthedocs for the load, download, and readfile functions. For only these three functions, the documentation for the function arguments overflows the width of the expected text area. Not sure why this is happening, but my guess is that it is because you used a different docstring formatting for these three functions compared to all your other functions.

You do not need to resolve this issue before the acceptance of your JOSS paper - just wanted to point this issue out to you since resolving this will make your API look cleaner

@GalagaBits
Copy link
Owner

Okay, I will look into this.

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

2 participants