Skip to content

Commit 3b49fd2

Browse files
authored
guideline for -Reasoning module imports (#2309)
1 parent d2ca7e8 commit 3b49fd2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/style-guide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,12 @@ automate most of this.
146146
as `Structures` etc.
147147
NB. Historical legacy means that these conventions have not always been observed!
148148

149+
* Special case of the above for `*-Reasoning` (sub-)modules: by analogy with
150+
`Relation.Binary.PropositionalEquality.≡-Reasoning`, when importing qualified
151+
the `-Reasoning` (sub-)module associated with a given (canonical) choice of
152+
symbol (eg. `` for `Preorder` reasoning), use the qualified name
153+
`<symbol>-Reasoning`, ie. `≲-Reasoning` for the example given.
154+
149155
* When using only a few items (i.e. < 5) from a module, it is a good practice to
150156
enumerate the items that will be used by declaring the import statement
151157
with the directive `using`. This makes the dependencies clearer, e.g.

0 commit comments

Comments
 (0)