Skip to content

Commit 24a13be

Browse files
committed
Add error variant name rule
1 parent 16e81d5 commit 24a13be

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

modules/contributor/pages/code-style-guide.adoc

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,43 @@ fn config_file(user: User) -> Result<(), Error> {
293293
294294
====
295295

296+
=== Error variant names
297+
298+
All error variants must not include any unnesecarry prefixes or suffixes.
299+
Examples of such prefixes include (but are not limited to) `FailedTo` and `UnableTo`.
300+
Furthermore, examples for suffixes are `Error` or `Snafu`
301+
Error variant names must however include verbs or identifiers as a prefix.
302+
303+
[WARNING.code-rule,caption=Examples of incorrect code for this rule]
304+
====
305+
306+
[source,rust]
307+
----
308+
#[derive(Snafu)]
309+
enum Error {
310+
FailedToParseConfig,
311+
HttpRequestError,
312+
ConfigRead,
313+
}
314+
----
315+
316+
====
317+
318+
[TIP.code-rule,caption=Examples of correct code for this rule]
319+
====
320+
321+
[source,rust]
322+
----
323+
#[derive(Snafu)]
324+
enum Error {
325+
ParseConfig,
326+
HttpRequest,
327+
ReadConfig,
328+
}
329+
----
330+
331+
====
332+
296333
=== Error messages
297334

298335
All our error messages must start with a lowercase letter and must not end with a dot.

0 commit comments

Comments
 (0)