Skip to content

Adding more pre-commit ruff rules for doc string

Wei Sheng Lai requested to merge wlai/salt:docstring into main

Description

Added more pre-commit ruff rules for more consistent doc-string.
More specifically:

  • D417 which check doc-string for undocumented parameters
  • D212 which checks location of first line of doc-string format

To respect D417 rule, I have added dummy text for some undocumented variables. I believe most of them are from the !221 (merged), tagging @npond who could verify this.

Relates to #54 (closed)

Review checklist:

  • CI Passing
  • Comments addressed
  • Source branch is up to date with target

Merge request reports