-
Notifications
You must be signed in to change notification settings - Fork 7
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
Fix how doc string looks in the documentation #156
Comments
Not sure how easy that's gonna be. Parameters and Returns are established standard terms which is why they get the pretty formatting. You'd likely need to dig pretty deep in the sphinx docs engine to get it to treat Original author the same way. I think it looks fine as is tbh! |
Yeah that is what we thought with Eleanor actually! I can have a look and if we do not fix it, it is also fine as it is |
What about finding another standard term that is applicable? Something like
Standard terms for docstrings appear to include singular Other conventions also possibly have (Note to self: Some basic info on docstrings: https://www.geeksforgeeks.org/python-docstrings/). |
I think Eleanor suggestion with notes and then the author works well |
Original author part looks funcky and not nicely as parameters and returns

The text was updated successfully, but these errors were encountered: