Skip to content

chore(Tactic): rewrite order tactic docstring#37927

Open
Vierkantor wants to merge 2 commits intoleanprover-community:masterfrom
Vierkantor:document-order-tactic
Open

chore(Tactic): rewrite order tactic docstring#37927
Vierkantor wants to merge 2 commits intoleanprover-community:masterfrom
Vierkantor:document-order-tactic

Conversation

@Vierkantor
Copy link
Copy Markdown
Contributor

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

The order_core docstring also gets a little rewrite to make clearer that it is an implementation detail (and also explain exactly what it does).


Open in Gitpod

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

The `order_core` docstring also gets a little rewrite to make clearer that it is an implementation detail (and also explain exactly what it does).
@Vierkantor Vierkantor added documentation Improvements or additions to documentation t-meta Tactics, attributes or user commands labels Apr 11, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 11, 2026

PR summary 062adc5c07

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).

@JovanGerb
Copy link
Copy Markdown
Contributor

Thanks!

If order_core is an implementation detail, could you mark it as a local syntax? That way, it is not usable outside of this file, and it won't show up in the automatically generated documentation.

@joneugster
Copy link
Copy Markdown
Contributor

Indeed, order_core not showing up in the generated docs seems preferrable.

LGTM otherwise, thanks!

@joneugster joneugster added the awaiting-author A reviewer has asked the author a question or requested changes. label Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-author A reviewer has asked the author a question or requested changes. 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.

3 participants