Skip to content

Commit f8984e1

Browse files
committed
docs(project-layout): add note on recommended target naming
1 parent 9e152bb commit f8984e1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/doc/src/guide/project-layout.md

+2
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ files, place a `main.rs` file along with the extra [*modules*][def-module]
4848
within a subdirectory of the `src/bin`, `examples`, `benches`, or `tests`
4949
directory. The name of the executable will be the directory name.
5050

51+
> **Note:** By convention, binaries, examples, benches and integration tests follow `kebab-case` naming style, unless there are compatibility reasons to do otherwise (e.g. compatibility with a pre-existing binary name). Modules within those targets are `snake_case` following the [Rust standard](https://rust-lang.github.io/rfcs/0430-finalizing-naming-conventions.html).
52+
5153
You can learn more about Rust's module system in [the book][book-modules].
5254

5355
See [Configuring a target] for more details on manually configuring targets.

0 commit comments

Comments
 (0)