-
Notifications
You must be signed in to change notification settings - Fork 13
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.
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
Explain/remove concepts/notations #282
Comments
For now, we should focus on putting out the biggest fires. This is anything in the Should be avoided and Needs rename sections. |
@WhatisRT Thank you for reorganizing this issue and making the priorities clear. 🚀 👍🏼 |
@WhatisRT why do you want to be forced to use parentheses around |
Addresses the following items of issue #282: - [x] `_⊎_` : sentence (in `Address.lagda`) before first figure in which it appears - [x] `_∷ʳ_` : footnote to caption of figure in which it appears. - [x] `_⁻¹` : footnote (in `Chain.lagda`) to caption of first figure in which it appears. - [x] `_∣_` : footnote (in `Utxo.lagda`) to caption of first figure in which it appears.
I remember adding such parentheses in my first cleanup PR; it is very easy to confuse it with the normal function space (esp. in some fonts where they are almost identical) and I also recall the fixity to be very brittle (you don't know if you want a map from functions or an input map...). To sum up, yes please always use parantheses when a map is part of a larger (function-with-arguments) type. |
Addresses the following items of issue #282: - [x] `_⊎_` : sentence (in `Address.lagda`) before first figure in which it appears - [x] `_∷ʳ_` : footnote to caption of figure in which it appears. - [x] `_⁻¹` : footnote (in `Chain.lagda`) to caption of first figure in which it appears. - [x] `_∣_` : footnote (in `Utxo.lagda`) to caption of first figure in which it appears.
* Rename ∅ᵐ → ∅ Addresses one item of #282 * rename empty set using typeclasses --------- Co-authored-by: Andre Knispel <andre.knispel@gmx.de>
Addresses one item in issue #282. (I'm a bit conflicted about this change since, while it might make the pdf easier for non-Agda/non-TT folks to read, it could cause confusion for Agda/TT folks who know that the usual `_≡_` wouldn't work here.)
This addresses one item of issue #282.
This addresses one item of issue #282.
This addresses one item of issue #282.
Unavoidable (Do later)
Things that we can either not avoid for technical reasons or because they would make things massively more difficult. These need to be explained.
record
definitions,record
syntax for (de)constructing valuesSet
in the PDF? #444Potentially avoidable (Do later)
Things that can be avoided/hidden at some cost. That cost needs to be weighed against the cost of adding an explanation (which also makes the document less accessible).
open
for recordsΣ
data
λ where
syntaxShould be avoided (Do soon)
These are things which aren't too difficult to avoid, are completely custom or only used in an FP context. Those need to have a very good reason to pay the cost of adding an explanation/increasing the barrier to entry.
module
syntax_≗_
(fig 5)(afaik, this no longer appears in fig 25)_⟪$⟫_
(fig 25)_<$>_
(fig 25)sp-∘
to-sp
uncurry
foldr
Need explanations/cleanup (Do soon)
Things that definitely we want to use but still should have a (potentially very short) explanation. Some things in here may also be improved by being renamed. Some renames may require type classes or other mechanisms.
Name is probably good:
_⊎_
_∷ʳ_
_⁻¹
_∣_
May benefit from a rename:
_↾_
_↾'_
_⊖_
_∘₂_
Needs rename:
Σᵐᵛ
->∑
, maybe∑ᵛ
?(this is difficult, see Makemapˢ
- since we now have aFunctor
class, we can make aninstance and write
map
insteadFunctor
instance forℙ_
#322)∅ᵐ
->∅
❴_❵ᵐ
->❴_❵
ℚ.0ℚ
->0ℚ
(0ℚ
->0
via literal overloading later)_ℚ.≥_
->_≥_
or_≤_
filterᵐ
->filter
(or maybe something else?)sucᵉ
->... + 1
mapPartial
#446The text was updated successfully, but these errors were encountered: