flow-forecast icon indicating copy to clipboard operation
flow-forecast copied to clipboard

ReadTheDocs compatible docstrings

Open isaacmg opened this issue 4 years ago • 2 comments

We have a lot of antiquated docstrings that don't render well into ReadTheDocs. A kind of grunge (but incredibly useful) task would be to refactor these docstrings into proper ReadTheDocs format. This would allow us to render them effectively...

isaacmg avatar May 14 '21 06:05 isaacmg

I use VS Code and there is an extension which automatically generates docstrings in readthedocs format.

train_transformer_style looks really good, so I assume you'd want them all in that style?

codeananda avatar May 28 '21 10:05 codeananda

Yes if you wanted to open a PR for that it would be really helpful.

isaacmg avatar May 28 '21 18:05 isaacmg