Skip to content

check with --ignore-magics does not exlcude these from the total number of checked functions #24

Description

@FelixTheC

When running uv run gendocs_new src\ --check --threshold 80 --ignore-magic

I receive

+--------------------------------+---------+----------+---------+---------+--------+
| File Path                      | Checked | Complete | Partial | Missing |  Score |
+--------------------------------+---------+----------+---------+---------+--------+
| ...int/active_directory_api.py |       5 |        5 |       0 |       0 | 100.0% |
| ...ect_checkpoint/api_utils.py |       3 |        3 |       0 |       0 | 100.0% |
| ...heckpoint/checkpoint_api.py |       3 |        3 |       0 |       0 | 100.0% |
| ...ckpoint/cli_access_roles.py |       3 |        3 |       0 |       0 | 100.0% |
| ...roject_checkpoint/config.py |       4 |        4 |       0 |       0 | 100.0% |
| .../checkpoint/access_roles.py |       1 |        1 |       0 |       0 | 100.0% |
| ...point/checkpoint_session.py |       7 |        6 |       0 |       1 |  85.7% |
+--------------------------------+---------+----------+---------+---------+--------+

Overall System Score: 96.2%

cause under checkpoint_session.py exists one __init__ function and this counts as Missing.

I would expect an overall score from 100% when using --ignore-magic and 0 Missing docstrings

Metadata

Metadata

Assignees

Labels

invalidThis doesn't seem right

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions