- Notifications
You must be signed in to change notification settings - Fork261
Closed
Description
Question
I started looking at fixing some of the sphinx errors, but Ruff and sphinx started fighting over things like
Arguments:-----------Then I realized that we don't have a standard docstring convention at all (also, in Google convention, at least, it's Args not Arguments, and it's not underlined). Many / most of the docs are in Sphinx style:
:param foo: ...:returns: xyzWhile these don't have the explicit type hints that the other docs do, I checked, and Sphinx can infer those anyway, though it's harder to read directly in the code.
Is it safe to assume we want to move towards using Sphinx docs style?
Side note: Looks like ruffcurrently doesn't support sphinx docstyle