Skip to content

docs: this PR provides comprehensive documentation for all macros covered in binding.md#1375

Open
HMarcien wants to merge 5 commits into
mighty-gerbils:documentation-updatesfrom
HMarcien:docs-binding
Open

docs: this PR provides comprehensive documentation for all macros covered in binding.md#1375
HMarcien wants to merge 5 commits into
mighty-gerbils:documentation-updatesfrom
HMarcien:docs-binding

Conversation

@HMarcien

Copy link
Copy Markdown

Key changes include:

  • New Structure: Reorganized the file into logical sections: Top-Level Definitions, Local Bindings, Procedure Abstractions, and Derived/Auxiliary Forms, with improved introductions.
  • Complete Documentation: Added detailed documentation for all binding forms, including:
    • Top-Level: def, def*, defvalues, extern, defsyntax, defrules, defrule, defalias.
    • Local Bindings: let, let*, letrec, letrec*.
    • Procedure Abstractions: lambda, case-lambda.
    • Derived Forms: cut, let/cc, rec, alet, alet*.

Completes the documentation for the 'Top-Level Definitions' section in `binding.md`.

This adds comprehensive documentation for the following fundamental binding forms:

- Runtime definitions: `def`, `def*`, `defvalues`, `extern`
- Syntactic definitions: `defsyntax`, `defrules`, `defrule`, `defalias`
This commit completes the documentation for the "Local Bindings" section in `binding.md`.

It adds comprehensive documentation for the four `let` forms:

- `let`
- `let*`
- `letrec`
- `letrec*`
This commit adds comprehensive documentation for the "Procedure Abstractions" section in `binding.md`.

It provides a detailed reference for the fundamental procedure-creating forms, `lambda` and `case-lambda`.
Completes the documentation for the "Derived and Auxiliary Forms" section in `binding.md`.

This adds comprehensive documentation for the following shortcut macros, used for common or advanced binding patterns:

- `cut` (SRFI 26 for partial application)
- `let/cc` (R7RS for continuation capture)
- `rec` (SRFI 31 for self-reference)
- `alet` (Gerbil conditional binding)
- `alet*` (Gerbil sequential conditional binding)
@HMarcien HMarcien changed the title This PR provides comprehensive documentation for all macros covered in binding.md docs: this PR provides comprehensive documentation for all macros covered in binding.md Oct 23, 2025
@vyzo vyzo requested a review from belmarca January 5, 2026 23:13
@vyzo

vyzo commented Jan 5, 2026

Copy link
Copy Markdown
Collaborator

@belmarca can you please review?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants