search

ladsantos / p-winds

Python implementation of Parker wind models for exoplanet atmospheres
https://p-winds.readthedocs.io/
MIT License
10 stars 5 forks source link

Render math in docstrings? #40

Closed gully closed 1 year ago

gully commented 1 year ago

Do folks here have a preference on putting some of the math in the docstrings? Here is a simple demo:

image

The main downside is that the Jupyter docstring does not render math, and so there's a bunch of unformatted $\LaTeX$, which can be distracting:

image

I suppose it comes down to whether most folks use the online docs or the Jupyter quick-look, and of course the developer time to copy-and-paste over the relevant latex.

ladsantos commented 1 year ago

Personally, for details of a code I usually go to the ReadTheDocs page. I use the Jupyter docstring lookup mostly to remind myself of input parameters. I will do some digging and see what I can come up with.