Skip to content
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

Closed
31 of 33 tasks
WhatisRT opened this issue Nov 7, 2023 · 5 comments
Closed
31 of 33 tasks

Explain/remove concepts/notations #282

WhatisRT opened this issue Nov 7, 2023 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@WhatisRT
Copy link
Collaborator

WhatisRT commented Nov 7, 2023

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.

Potentially 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
  • implicit arguments
  • Σ
  • data
  • λ where syntax
  • Copatterns

Should 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)
  • _⟪$⟫_ (fig 25) (afaik, this no longer appears in 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 ∑ᵛ?
  • mapˢ - since we now have a Functor class, we can make an
    instance and write map instead
    (this is difficult, see Make Functor instance for ℙ_ #322)
  • ∅ᵐ ->
  • ❴_❵ᵐ -> ❴_❵
  • ℚ.0ℚ -> 0ℚ (0ℚ -> 0 via literal overloading later)
  • _ℚ.≥_ -> _≥_ or _≤_
  • filterᵐ -> filter (or maybe something else?)
  • sucᵉ -> ... + 1
  • Naming of mapPartial #446
@WhatisRT WhatisRT added this to the Nov - Feb milestone Nov 7, 2023
@WhatisRT WhatisRT added the documentation Improvements or additions to documentation label Nov 7, 2023
@WhatisRT
Copy link
Collaborator Author

WhatisRT commented Nov 7, 2023

For now, we should focus on putting out the biggest fires. This is anything in the Should be avoided and Needs rename sections.

@williamdemeo
Copy link
Contributor

@WhatisRT Thank you for reorganizing this issue and making the priorities clear. 🚀 👍🏼

williamdemeo added a commit that referenced this issue Nov 14, 2023
Addresses one item of #282
williamdemeo added a commit that referenced this issue Nov 14, 2023
@williamdemeo williamdemeo mentioned this issue Nov 14, 2023
3 tasks
williamdemeo added a commit that referenced this issue Nov 14, 2023
williamdemeo added a commit that referenced this issue Nov 14, 2023
WhatisRT pushed a commit that referenced this issue Nov 15, 2023
Addresses one item of #282
WhatisRT pushed a commit that referenced this issue Nov 15, 2023
williamdemeo added a commit that referenced this issue Nov 15, 2023
@williamdemeo
Copy link
Contributor

@WhatisRT why do you want to be forced to use parentheses around A ⇀ B? I thought one nice feature of our symbol was that we didn't need parens.

williamdemeo added a commit that referenced this issue Nov 17, 2023
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.
This was referenced Nov 17, 2023
@omelkonian
Copy link
Collaborator

@WhatisRT why do you want to be forced to use parentheses around A ⇀ B? I thought one nice feature of our symbol was that we didn't need parens.

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.

williamdemeo added a commit that referenced this issue Nov 17, 2023
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.
williamdemeo added a commit that referenced this issue Nov 17, 2023
* Rename  ∅ᵐ → ∅

Addresses one item of #282

* rename empty set using typeclasses

---------

Co-authored-by: Andre Knispel <andre.knispel@gmx.de>
@WhatisRT WhatisRT modified the milestones: Nov - Feb, Feb - Apr Feb 6, 2024
williamdemeo added a commit that referenced this issue Feb 9, 2024
as requested in issue #282
williamdemeo added a commit that referenced this issue Feb 9, 2024
williamdemeo added a commit that referenced this issue Feb 9, 2024
as requested in issue #282
williamdemeo added a commit that referenced this issue Feb 9, 2024
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.)
williamdemeo added a commit that referenced this issue Feb 15, 2024
This addresses one item of issue #282.
williamdemeo added a commit that referenced this issue Feb 15, 2024
This addresses one item of issue #282.
williamdemeo added a commit that referenced this issue Feb 15, 2024
This addresses one item of issue #282.
WhatisRT pushed a commit that referenced this issue Feb 16, 2024
* PDF cleanup 282: hide `module` syntax

This addresses one item of issue #282.

* mod suggested in PR review
WhatisRT pushed a commit that referenced this issue Feb 19, 2024
* PDF cleanup: hide `λ where` syntax

This addresses one item of issue #282.
WhatisRT pushed a commit that referenced this issue Feb 19, 2024
* PDF cleanup 282: hide `data` keyword

This addresses one item of issue #282.
@WhatisRT WhatisRT modified the milestones: Feb - Apr, May - Jul May 3, 2024
@WhatisRT
Copy link
Collaborator Author

WhatisRT commented Jun 4, 2024

Closing in favour of #444, #446 and #447.

@WhatisRT WhatisRT closed this as completed Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants