jjmoore1970/usedocstringsovercomments icon
public
Published on 6/22/2025
use-docstrings-over-comments

[R] Python docstrings

Rules

[R] docstrings rules

  • Use Python docstrings (triple quotes) to describe the purpose, inputs, outputs, and side effects of functions and classes.
  • Follow a consistent style like Google or NumPy.
  • Avoid using # comments for documenting functions.