AstroPhot icon indicating copy to clipboard operation
AstroPhot copied to clipboard

Convert docstrings to google format

Open ConnorStoneAstro opened this issue 3 years ago • 1 comments

describe the content in question

All AutoProf methods require docstrings, these should be formatted in google notation. This notation is easily readable in text format as well, making it useful for help strings at the interpreter level as well.

example use case

Example google notation docs can be seen here: https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html

brief outline of updated documentation

This only applies to docstrings

ConnorStoneAstro avatar Feb 06 '23 04:02 ConnorStoneAstro

Ultimately joopyter book has struggled with every docs format, so I am using markdown now and manually building notebooks with the docs. This is closed by #267

ConnorStoneAstro avatar Aug 01 '25 15:08 ConnorStoneAstro