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

Fix how doc string looks in the documentation #156

Open
MOchiara opened this issue Dec 2, 2024 · 4 comments
Open

Fix how doc string looks in the documentation #156

MOchiara opened this issue Dec 2, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@MOchiara
Copy link
Member

MOchiara commented Dec 2, 2024

Original author part looks funcky and not nicely as parameters and returns
image

@callumrollo callumrollo added the documentation Improvements or additions to documentation label Dec 2, 2024
@callumrollo
Copy link
Member

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!

@MOchiara
Copy link
Member Author

MOchiara commented Dec 2, 2024

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

@eleanorfrajka
Copy link
Collaborator

eleanorfrajka commented Dec 3, 2024

What about finding another standard term that is applicable? Something like

Notes
------
Original author: Chiara Monforte
Method update: X Y

Standard terms for docstrings appear to include singular Parameters, Yields or Returns, Other Parameter, Raises (for errors), Sea Also, Note or Notes, References, Example/Examples, (https://developer.lsst.io/python/numpydoc.html)

Other conventions also possibly have Attributes, Todo? (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)

(Note to self: Some basic info on docstrings: https://www.geeksforgeeks.org/python-docstrings/).

@MOchiara
Copy link
Member Author

MOchiara commented Dec 3, 2024

I think Eleanor suggestion with notes and then the author works well

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

No branches or pull requests

3 participants