Repository navigation
Fix module and function names in documentation examples - #180
Merged
josevalim merged 1 commit intoOct 16, 2026
Merged
Conversation
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
Use the module and function names defined earlier in the module documentation:
MyApp.Weathertodefmock/2, but the behaviour is namedMyApp.WeatherAPI. Evaluating the snippet with the preceding definitions raisesArgumentError(could not load module MyApp.Weather,:nofile).MyApp.HumanizedWeather.temp/1, but that module definesdisplay_temp/1. The documented call raisesUndefinedFunctionErrorbefore invoking the mock.This changes only those three references, leaving the examples' synchronization explanation and the runtime implementation unchanged.
Validation
On Elixir 1.18.4 / OTP 25:
mix test test/mox_test.exs --seed 0: 76 tests, 0 failures.mix format --check-formattedmix deps.unlock --check-unusedmix compile --warnings-as-errorsgit diff --checkDid not run
test/cluster_test.exsor the full Elixir/OTP matrix. No external weather request was made.