Skip to content
Snippets Groups Projects
Commit d063b13b authored by Robbert Krebbers's avatar Robbert Krebbers
Browse files

Merge branch 'robbert/naming_order' into 'master'

Naming convention about lookup/elem_of.

See merge request iris/iris!988
parents cd965573 44beff0e
No related branches found
No related tags found
No related merge requests found
...@@ -221,6 +221,7 @@ theories/base_logic/lib is for constructions in the base logic (using own) ...@@ -221,6 +221,7 @@ theories/base_logic/lib is for constructions in the base logic (using own)
* Lower-case theorem names, lower-case types, upper-case constructors * Lower-case theorem names, lower-case types, upper-case constructors
* **TODO:** how should `f (g x) = f' (g' x)` be named? * **TODO:** how should `f (g x) = f' (g' x)` be named?
* `list_lookup_insert` is named by context (the type involved), then the two functions outside-in on the left-hand-side, so it has the type `lookup (insert …) = …` where the `insert` is on a list. Notations mean it doesn’t actually look like this and the insert is textually first. * `list_lookup_insert` is named by context (the type involved), then the two functions outside-in on the left-hand-side, so it has the type `lookup (insert …) = …` where the `insert` is on a list. Notations mean it doesn’t actually look like this and the insert is textually first.
* Operations that "extract" from the data structure (`lookup`, `elem_of`, ...) should come before operations that "alter" the data structure (`filter`, `insert`, `union`, `fmap`). For example, use `map_lookup_filter` instead of `map_filter_lookup`.
* Injectivity theorems are instances of `Inj` and then are used with `inj` * Injectivity theorems are instances of `Inj` and then are used with `inj`
* Suffixes `_l` and `_r` when we have binary `op x y` and a theorem related to the left or right. For example, `sep_mono_l` says bi_sep is monotonic in its left argument (holding the right constant). * Suffixes `_l` and `_r` when we have binary `op x y` and a theorem related to the left or right. For example, `sep_mono_l` says bi_sep is monotonic in its left argument (holding the right constant).
* Suffix `'` (prime) is used when `foo'` is a corollary of `foo`. Try to avoid * Suffix `'` (prime) is used when `foo'` is a corollary of `foo`. Try to avoid
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment