Export oft-used types w/o exposing implementation #1
Conversation
This file contains 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
|
@max-au does this look ready to open against erlang/otp? |
max-au
reviewed
Jan 20, 2021
Export more types that meet these criteria:
- Documented
- Convenient for client code. They are already
used in specs of public functions of their respective
modules.
- These types do not expose implementation details.
The types are:
ets.erl:
- type() :: set | ordered_set | bag | duplicate_bag.
supervisor.erl:
- `restart() :: 'permanent' | 'transient' | 'temporary'
- `mfargs() :: {M :: module(), F :: atom(), A :: [term()]
| undefined}.`
- `shutdown() :: 'brutal_kill' | timeout().`
The reason for this change is to fix the status quo, which is
that teams either must:
- copy/pasta the types into client code, leading to code bloat and having
to manually keep the types in sync.
- OR refer to non-exported types, which will mean either more noise
or less accuracy from code analysis tools. For example,
Dialyzer will either warn or treat the types as `term()`.
mheiber
force-pushed
the
export-more-types
branch
from
d1e9071
to
c049e0d
Compare
|
closing, opening against otp erlang 🤞 |
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.
Export more types that meet these criteria:
used in specs of public functions of their respective
modules.
The types are:
ets.erl:
re.erl:
supervisor.erl:
mfargs() :: {M :: module(), F :: atom(), A :: [term()] | undefined}.shutdown() :: 'brutal_kill' | timeout().The reason for this change is to fix the status quo, which is
that teams either must:
to manually keep the types in sync.
or less accuracy from code analysis tools. For example,
Dialyzer will either warn or treat the types as
term().