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
Docstrings across the codebase are useful but inconsistent: some mix "what this does" with open design questions and TODOs, some use :param: style, some are prose. Many inline comments restate what well-named code already says.
Proposed pass:
Pick a docstring style (e.g. Google or NumPy) and apply uniformly.
Move open design questions and TODOs out of docstrings into GitHub issues so docs reflect intent, not history.
Docstrings across the codebase are useful but inconsistent: some mix "what this does" with open design questions and TODOs, some use
:param:style, some are prose. Many inline comments restate what well-named code already says.Proposed pass:
Related to #1.