Different styles between examples that should panic #73196
Labels
A-docs
Area: documentation for any part of the project, including the compiler, standard library, and tools
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
E-easy
Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
I happened to stumble across this documentation earlier, and was surprised by the style of the following example of code that should panic:
In particular, this does not seem to use the
should_panic
attribute that is used in other places in the documentation (egOption
's unwrap ). As a result, it seems unnecessarily hard to read especially since this is a method which is likely to be of interest even for very new users. I was going to open a PR fixing this, but first wanted to ask if there is any particular reason for or benefit from this style? It also appears in a number of other places in the documentation forchar
- I have not yet searched elsewhere.The text was updated successfully, but these errors were encountered: