Skip to content

Documentation for incremental module definitions#1087

Open
Gustavo2622 wants to merge 1 commit into
fix-module-update-basesfrom
doc-module-update
Open

Documentation for incremental module definitions#1087
Gustavo2622 wants to merge 1 commit into
fix-module-update-basesfrom
doc-module-update

Conversation

@Gustavo2622

Copy link
Copy Markdown
Contributor

This adds documentation for the incremental / fine-grained module definition syntax / functionality.

It depends on #1086

@Gustavo2622
Gustavo2622 requested a review from Cameron-Low July 24, 2026 11:03
@Gustavo2622 Gustavo2622 self-assigned this Jul 24, 2026
@Gustavo2622
Gustavo2622 marked this pull request as ready for review July 24, 2026 11:28
@fdupress

Copy link
Copy Markdown
Member

Change the target branch to avoid the commit count failure. The target will automatically change when we merge the other PR.

@Gustavo2622
Gustavo2622 changed the base branch from main to fix-module-update-bases July 26, 2026 15:34
@Gustavo2622
Gustavo2622 force-pushed the fix-module-update-bases branch from 2cd9b21 to ba119b8 Compare July 26, 2026 15:36
Adds doc/language/module-update.rst, documenting `module M' = M with
{...}`: syntax, the copy/share semantics, restrictions, and worked
examples (ghost-state instrumentation, statement and result rewrites,
loop edits, match-branch collapse, functor and sub-module updates).

The code-position language (shared by the program tactics and by module
updates) is factored out into its own page,
doc/language/code-positions.rst, which module-update.rst references.

The section on sub-module and applied-functor bases documents the
semantics introduced by the parent commit (sound module updates on
sub-module and applied-functor bases); its example is executable and
mirrors the regression tests in tests/module-update-bases.ec.  This
change is meant to be merged after that fix.

Both pages are marked :orphan: until a language-reference toctree
lands.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants