Fix Kernel.SpecialForms references in Macro.Env docs - #15712
Merged
josevalim merged 1 commit intoAug 3, 2026
Merged
Conversation
The docs for Macro.Env.define_require/4, define_import/4, and define_alias/4 refer to `Kernel.SpecialForm.require/2`, `Kernel.SpecialForm.import/2`, and `Kernel.SpecialForm.alias/2` (singular). The module is called Kernel.SpecialForms, so ExDoc cannot resolve these references into links. Assisted-by: Claude Code:claude-fable-5 Signed-off-by: makoto-developer <72484465+makoto-developer@users.noreply.github.com>
josevalim
marked this pull request as ready for review
August 3, 2026 08:38
Member
|
💚 💙 💜 💛 ❤️ |
Contributor
Author
|
Thank you |
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
2 participants
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.
The docs for
Macro.Env.define_require/4,Macro.Env.define_import/4, andMacro.Env.define_alias/4refer toKernel.SpecialForm.require/2,Kernel.SpecialForm.import/2(twice), andKernel.SpecialForm.alias/2— themodule name is missing the trailing "s". Since the module is called
Kernel.SpecialForms, ExDoc cannot resolve these references, so they render asplain code spans instead of links (see e.g. the current
define_import/4docs).This fixes the four occurrences in
lib/elixir/lib/macro/env.ex.Found by mechanically verifying that every
Mod.fun/arityreference in thedocs resolves to an existing function, macro, callback, or type.