docs: say how to name modules, and why it matters more than it looks - #1
Merged
Conversation
A module has one declaration site in the whole program, dependencies included, so two packages that both declare mod Cube cannot be used together. Adds the convention Flix libraries follow.
wstein
force-pushed
the
docs/module-naming
branch
from
August 27, 2026 20:47
1c52a5f to
8be3fa6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A module has one declaration site in the whole program, dependencies included — two packages that both declare
mod Cubecannot be used together, and nothing warns you until someone tries.Adds the convention Flix libraries already follow: one root namespace named after the package, directories mirroring module paths,
Internalfor what is not API, names spelled out, flat tests. README section plus the same as bullets inAGENTS.md.Docs only.