change DynamicSupervisor doc to avoid confusions #13678
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
josevalim
reviewed
Jun 19, 2024
josevalim
approved these changes
Jun 19, 2024
josevalim
reviewed
Jun 19, 2024
|
@josevalim , I removed the suggested change of writing |
josevalim
reviewed
Jun 19, 2024
josevalim
reviewed
Jun 19, 2024
|
Parenthesis are required on both, that should fix it. CI should show the difference too! |
|
💚 💙 💜 💛 ❤️ |
Comment on lines
-218
to
-219
| @typedoc "Options given to `start_link` functions" | ||
| @type option :: GenServer.option() |
There was a problem hiding this comment.
This now-removed type was being used at https://github.com/elixir-lang/elixir/blob/main/lib/elixir/lib/task/supervisor.ex#L77C1-L77C37 which now needs to be updated
There was a problem hiding this comment.
done and thanks:
#13704
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.
Clearly distinguishes between an init option provided as initial argument to DynamicSupervisor, and a regular "GenServer type" option provided as third argument in
start_link/3fix #13675