PlasmaControl / DESC

Stellarator Equilibrium and Optimization Suite
MIT License
95 stars 27 forks source link

Improve docstrings by enclosing references to kwargs, classes, and methods in backticks #700

Open dpanici opened 1 year ago

dpanici commented 1 year ago

Our docstrings could be improved by referring to kwargs inside the docstring with back ticks like "corresponds to size of kwarg" instead of "corresponds to size of kwarg"

dpanici commented 3 months ago

Use double backticks (THING) for code args/variables etc., but class names which are captialized can be in plain text as is - basically use the backticks to make sure the docstring is clear