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

fix: do not count un-deprecations in Mathlib/Deprecated #19184

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

adomani
Copy link
Collaborator

@adomani adomani commented Nov 18, 2024

Copy link

github-actions bot commented Nov 18, 2024

PR summary 035c73548d

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

No declarations were harmed in the making of this PR! 🐙

You can run this locally as follows
## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>

## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>

The doc-module for script/declarations_diff.sh contains some details about this script.


Increase in tech debt: (relative, absolute) = (1.00, 0.01)
Current number Change Type
71 1 disabled deprecation lints

Current commit 035c73548d
Reference commit d51f67b0be

You can run this locally as

./scripts/technical-debt-metrics.sh pr_summary
  • The relative value is the weighted sum of the differences with weight given by the inverse of the current value of the statistic.
  • The absolute value is the relative value divided by the total sum of the inverses of the current values (i.e. the weighted average of the differences).

Copy link
Contributor

@Vierkantor Vierkantor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a suggestion but it looks good enough to me either way, thanks!

bors d+

scripts/technical-debt-metrics.sh Outdated Show resolved Hide resolved
@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Nov 18, 2024

✌️ adomani can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

@adomani
Copy link
Collaborator Author

adomani commented Nov 18, 2024

Given how the discussion evolved in the Zulip chat, I am going to extract this using a variation of

# count total number of `set_option linter.deprecated false`
deprecs="$(git grep -c "set_option linter.deprecated false" | awk -F: 'BEGIN{total=0} {total+=$2} END{print total}')"

# count the `linter.deprecated` exceptions that are themselves ones that are followed by `deprecated ...(since`
doubleDeprecs="$(git grep -A1 "set_option linter.deprecated false" | grep -c "deprecated .*(since")"

echo "$(( deprecs - doubleDeprecs ))"

that only searches outside the Deprecated dir.

…ons' of github.com:leanprover-community/mathlib4 into adomani/tech_debts_do_not_report_deprecated_undeprecations
@adomani adomani force-pushed the adomani/tech_debts_do_not_report_deprecated_undeprecations branch from 80ee4b9 to 035c735 Compare November 18, 2024 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants