Skip to content

Sentence "The bad state is not something that’s *expected* to happen occasionally." could be written more clearly. #2833

@mzagrabe

Description

@mzagrabe
  • I have checked the latest main branch to see if this has already been fixed
  • I have searched existing issues and pull requests for duplicates

URL to the section(s) of the book with this problem:

https://github.com/rust-lang/book/blob/main/src/ch09-03-to-panic-or-not-to-panic.md

Description of the problem:

Thank you for writing the Rust Book. It is appreciated and I am learning many things. Kudos to a job well done!

The sentence,

"* The bad state is not something that’s expected to happen occasionally."

does not read well. The three words, "not", "expected", and "occasionally" force the reader to make cognitive switches about when it is proper to panic! for "bad state". I'm still not sure about when this bullet point would apply to the context of the section it resides in.

Suggested fix:

Perhaps:

"The bad state is something that is unexpected and occurs infrequently."

Maybe also provide an example for each of the three bullet points in this section.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions