Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve backend documentation #6

Closed
mostafa opened this issue Nov 16, 2022 · 0 comments
Closed

Improve backend documentation #6

mostafa opened this issue Nov 16, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation velocity Issues that improve our velocity

Comments

@mostafa
Copy link
Member

mostafa commented Nov 16, 2022

I ran interrogate on the repository and it reported 23.7% coverage of docstring, which is low.

$ poetry add interrogate
$ poetry run interrogate -v
========================= Coverage for /pySigma-backend-loki/ ==========================
-------------------------------------------------- Summary ---------------------------------------------------
| Name                                           |        Total |        Miss |        Cover |        Cover% |
|------------------------------------------------|--------------|-------------|--------------|---------------|
| sigma/backends/loki/__init__.py                |            1 |           1 |            0 |            0% |
| sigma/backends/loki/loki.py                    |           33 |           7 |           26 |           79% |
| sigma/pipelines/loki/__init__.py               |            1 |           1 |            0 |            0% |
| sigma/pipelines/loki/loki.py                   |            2 |           2 |            0 |            0% |
| tests/sigma_backend_tester.py                  |            6 |           6 |            0 |            0% |
| tests/test_backend_loki.py                     |           44 |          42 |            2 |            5% |
| tests/test_backend_negation_loki.py            |           29 |          29 |            0 |            0% |
| tests/test_pipelines_loki.py                   |            2 |           2 |            0 |            0% |
|------------------------------------------------|--------------|-------------|--------------|---------------|
| TOTAL                                          |          118 |          90 |           28 |         23.7% |
------------------------------- RESULT: FAILED (minimum: 80.0%, actual: 23.7%) -------------------------------

It'd be nice if this is increased by adding more docstrings and module-level docs.

#6 (comment)

This should also include moving existing comments into docstring format (see #8).

@mostafa mostafa added the documentation Improvements or additions to documentation label Nov 16, 2022
@mostafa mostafa closed this as completed Jul 10, 2023
@mostafa mostafa reopened this Jul 10, 2023
@kelnage kelnage changed the title Docstring coverage Improve backend documentation Oct 20, 2023
@toopricey toopricey added the velocity Issues that improve our velocity label Dec 29, 2023
@kelnage kelnage closed this as completed Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation velocity Issues that improve our velocity
Projects
None yet
Development

No branches or pull requests

3 participants