Repository navigation
docs: state when Zig named modules resolve strong - #97
Merged
Merged
Conversation
The language table said named modules resolve "(strong)" as a build.zig states it, without the condition the release adds: a binding counts only when every build.zig of the repository is closed (Ark can follow all of its code) and the binding is the only one; otherwise every import is a candidate. Say so in README.md and README_ja.md, and link to the Zig section of the language support page, which has the details.
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
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.
Summary
Clarify in the README language table when Zig named modules resolve as strong.
The table said Ark resolves named modules "by the importing module's import table as a build.zig states it (strong)". Since #95, a binding a build.zig states counts only when every
build.zigof the repository is closed — Ark can follow all of its code (no dependency, no build helper file, no ZON import, nothing it does not model) — and the binding is the only one. Otherwise every Zig import is a candidate. Without the condition, the row read as if named modules were strong in general, which they are not in most real projects.Changes
README.md: the Zig row states the condition, says that other builds make every import a candidate, and links to the Zig section ofdocs/language-support.md.README_ja.md: the same in Japanese.No code change.
docs/language-support.mdanddocs/development/zig.mdalready describe the rule in full.Verification
go test ./, the packages whose tests read the READMEs (docs_test.go,internal/mcp,internal/commandline,internal/syntax,internal/libgitignore,tests/integration): pass.make fmt-check: pass.docs/language-support.md#zigexists (## Zig).