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

Add documentation to all Coalton faux macros #1282

Open
Izaakwltn opened this issue Oct 2, 2024 · 0 comments
Open

Add documentation to all Coalton faux macros #1282

Izaakwltn opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Izaakwltn
Copy link
Collaborator

Currently meta-dotting to certain Coalton macros drops you into a dead-end definition in /src/faux-macros.lisp with no documentation about implementation.

For instance and in Coalton only works on Booleans and can't be used for existence predicates like in Common Lisp.

This is a reasonable implementation but there is no documentation to confirm that this is the case.

These are the macros without documentation:

(define-coalton-editor-macro coalton:or (&rest args))

(define-coalton-editor-macro coalton:and (&rest args))

(define-coalton-editor-macro coalton:if (expr then else))

(define-coalton-editor-macro coalton:when (expr &body body))

(define-coalton-editor-macro coalton:unless (expr &body body))

(define-coalton-editor-macro coalton:cond (&rest clauses))

(define-coalton-editor-macro coalton:do (&body body))

(define-coalton-editor-macro coalton:return (&optional value))

(define-coalton-editor-macro coalton:loop (&body body))

(define-coalton-editor-macro coalton:while (test &body body))

(define-coalton-editor-macro coalton:while-let (pattern = test &body body))

(define-coalton-editor-macro coalton:for (pattern in iter &body body))

(define-coalton-editor-macro coalton:break (&optional label))

(define-coalton-editor-macro coalton:continue (&optional label))
@Izaakwltn Izaakwltn added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 2, 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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant