Remove feature convenience
#113
Merged
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
This feature was originally designed as an opt-out from panicking methods, which have a Result/Option-based overload, such as from_variant (try_from_variant), instance_id (instance_id_or_none), cast (try_cast), etc. However, it does not really add much in practice besides maintenance overhead. To still warn people to not accidentally use one of these methods, a warning sign is prepended to the brief doc. This should show up first in IDEs. Note that the warning sign is not added to every panicking method, but particularly those which have a "try" overload. To know which methods panic, check out if it contains a `# Panics` section.
Bromeon
added
documentation
|
bors r+ |
|
Build succeeded: |
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.
Instead prepends panicking methods with the⚠️ symbol (if they have a "try" overload).
This should show up first in docs and IDE auto-completion.
Also adds crate-level docs about the design behind our ergonomics and fast prototyping.
Closes #60.