We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 0a4d8cd commit f97e06fCopy full SHA for f97e06f
Documentation/rust/docs.rst
@@ -87,7 +87,9 @@ This example showcases a few ``rustdoc`` features and some common conventions
87
safe under a ``Safety`` section.
88
89
* While not shown here, if a function may panic, the conditions under which
90
- that happens must be described under a ``Panics`` section.
+ that happens must be described under a ``Panics`` section. Please note that
91
+ panicking should be very rare and used only with a good reason. In almost
92
+ all cases, you should use a fallible approach, returning a `Result`.
93
94
* If providing examples of usage would help readers, they must be written in
95
a section called ``Examples``.
0 commit comments