You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In most of the libs, specifically the snap lib, the conventions around docstrings and formatting have become disjointed. What made me notice this particularly was around how optional args are annotated in docstrings.
In general, I'd prefer not to include optionality/defaults in the Args: section where that info is already available in the function signature with type annotations, but if we're going to do it, it should at least be consistent.
In most of the libs, specifically the
snap
lib, the conventions around docstrings and formatting have become disjointed. What made me notice this particularly was around howoptional
args are annotated in docstrings.In general, I'd prefer not to include optionality/defaults in the
Args:
section where that info is already available in the function signature with type annotations, but if we're going to do it, it should at least be consistent.Triggered from a review in #88
The text was updated successfully, but these errors were encountered: