[chirp_devel] docstring formatting standard?

[Dan Smith]

> Which docstring formatting standard am I supposed to be using? I noticed that some existing docstrings place an @ in front of parameter names in-line with otherwise unformatted descriptions, but that doesn't correspond to any of these:

Yeah, the @paramname stuff is from me I'm sure, based on something I was using (not for chirp) more than ten years ago.

> Sphinx syntax:
> :param param1: The first parameter, defaults to 1.
> :type: int

This is my current preferred way of doing it, based on code I write elsewhere and for which it matters.

--Dan