Improve Supervisor docs and specs #7871
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
eksperimental
commented
Jul 11, 2018
lib/elixir/lib/supervisor.ex
Outdated
| @@ -529,12 +528,12 @@ defmodule Supervisor do | |||
| | {:max_seconds, pos_integer} | |||
|
|
|||
| @typedoc "Supported strategies" | |||
| @type strategy :: :one_for_one | :one_for_all | :rest_for_one | |||
| @type strategy :: :one_for_one | :one_for_all | :rest_for_one | :simple_one_for_one | |||
There was a problem hiding this comment.
Even though it has been deprecated, it should still be reflected in the typespecs
There was a problem hiding this comment.
We have recently agreed in another issue that we won'tkeep in typespecs as we do want the warning there still.
eksperimental
commented
Jul 11, 2018
lib/elixir/lib/supervisor.ex
Outdated
|
|
||
| # Note we have inlined all types for readability | ||
| @typedoc "The supervisor specification" | ||
| @type child_spec :: %{ | ||
| required(:id) => term(), | ||
| required(:id) => module() | term(), |
There was a problem hiding this comment.
Even though it's redundant it shows what's the default :id
There was a problem hiding this comment.
I think atom() is better as the module() is just a consequence of the atom.
|
❤️ 💚 💙 💛 💜 |
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.
No description provided.