chore(Tactic): rewrite order tactic docstring#37927
Open
Vierkantor wants to merge 2 commits intoleanprover-community:masterfrom
Open
chore(Tactic): rewrite order tactic docstring#37927Vierkantor wants to merge 2 commits intoleanprover-community:masterfrom
order tactic docstring#37927Vierkantor wants to merge 2 commits intoleanprover-community:masterfrom
Conversation
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).
PR summary 062adc5c07Import changes for modified filesNo significant changes to the import graph Import changes for all files
Declarations diffNo 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 No changes to technical debt.You can run this locally as
|
Contributor
|
Thanks! If |
Contributor
|
Indeed, LGTM otherwise, thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR rewrites the docstrings for the
ordertactic, to consistently match the official style guide, to make sure they are complete while not getting too long.The
order_coredocstring also gets a little rewrite to make clearer that it is an implementation detail (and also explain exactly what it does).