Skip to content

Commit

Permalink
Update .github/contributing/docs_guide.md
Browse files Browse the repository at this point in the history
Co-authored-by: Rich Churcher <rich.churcher@gmail.com>
  • Loading branch information
tguichaoua and richchurcher committed Sep 23, 2024
1 parent dcd4a4a commit 6650188
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/contributing/docs_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide aims to ensure consistency in the Bevy crates documentation, they sho
2. The first line is followed by an empty line.
3. The documentation may contain more details.
4. Links are usually placed at the end, depending on context (inline links may be useful clarification in a longer documentation block).
5. The crate attributes (`#![attribute]`) are placed _after_ the documentation.
5. The crate attributes (`#![attribute]`) are placed _before_ the documentation. Consumers of the documentation are more likely to visit generated docs, rather than reading them in the source files.

The format of the documentation will depend on the kind of the crate.

Expand Down

0 comments on commit 6650188

Please sign in to comment.