Skip to content

chore(Tactic): document the says tactic combinator#38290

Open
Vierkantor wants to merge 1 commit intoleanprover-community:masterfrom
Vierkantor:document-says-tactic
Open

chore(Tactic): document the says tactic combinator#38290
Vierkantor wants to merge 1 commit intoleanprover-community:masterfrom
Vierkantor:document-says-tactic

Conversation

@Vierkantor
Copy link
Copy Markdown
Contributor

This PR rewrites the docstrings for the says tactic combinator, to consistently match the official style guide, to make sure they are complete while not getting too long.

The structure is now:

  • explain what says does,
  • explain why you would want to use it,
  • explain how to update/apply a says.

Open in Gitpod

This PR rewrites the docstrings for the `says` tactic combinator, to consistently match the [official style guide](https://github.com/leanprover/lean4/blob/master/doc/style.md#tactics), to make sure they are complete while not getting too long.

The structure is now:
* explain what `says` does,
* explain why you would want to use it,
* explain how to update/apply a `says`.
@Vierkantor Vierkantor added documentation Improvements or additions to documentation t-meta Tactics, attributes or user commands labels Apr 20, 2026
@github-actions
Copy link
Copy Markdown

PR summary b80f227194

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/pr_summary/declarations_diff.sh <optional_commit>

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

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


No changes to technical debt.

You can run this locally as

./scripts/reporting/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).

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 t-meta Tactics, attributes or user commands

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant