Choose calculation variant to calculate the code churn metric #176
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @ishepard,
as propsed in #175 I have implemented another variant of the churn metric calculation, that can be configured in the initialization of the
CodeChurn
class:To ensure that this new calculation will not break anything,
add_deleted_lines_to_churn
is set toFalse
per default.The calculation variant switch is trivial:
I've added the corresponding unit test
test_with_add_deleted_lines_flag()
intest_code_churn.py
that proves the correct behavior of the new variant.I've also added/modified a part of the documentation (
processmetrics.rst
) to include the new variant and the parameter.I hope I haven't missed anything else.