Skip to content

Style guide: guideline for -Reasoning module imports cf #2282 #2309

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.

Sign up for GitHub

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

Merged
MatthewDaggitt merged 1 commit into from
Mar 6, 2024
Merged

Style guide: guideline for -Reasoning module imports cf #2282 #2309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,12 @@ automate most of this.
as `Structures` etc.
NB. Historical legacy means that these conventions have not always been observed!

* Special case of the above for `*-Reasoning` (sub-)modules: by analogy with
`Relation.Binary.PropositionalEquality.≡-Reasoning`, when importing qualified
the `-Reasoning` (sub-)module associated with a given (canonical) choice of
symbol (eg. `≲` for `Preorder` reasoning), use the qualified name
`<symbol>-Reasoning`, ie. `≲-Reasoning` for the example given.

* When using only a few items (i.e. < 5) from a module, it is a good practice to
enumerate the items that will be used by declaring the import statement
with the directive `using`. This makes the dependencies clearer, e.g.
Expand Down