pySigma-backend-loki icon indicating copy to clipboard operation
pySigma-backend-loki copied to clipboard

Published 20 hours ago • verified publisher icon grafana

Move comments into the docstring

Open mostafa opened this issue 1 year ago • 0 comments

I think these comments belong to the docstring. You can have a Notes: title in the docstring and add these comments there. Currently there are two (or possibly more) conventions:

  1. PEP 257
  2. Google style docstrings

I personally prefer the Google style, because it is more readable.

https://github.com/grafana/pySigma-backend-loki/blob/b6b2e6553c1700791a73ddcbf4315421c94cd57f/sigma/backends/loki/loki.py#L175-L189

mostafa avatar Nov 17 '22 12:11 mostafa