From 6650188f7ec9fc7993d66f4fd1fbeb0bc248ab67 Mon Sep 17 00:00:00 2001 From: Tristan Guichaoua <33934311+tguichaoua@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:03:42 +0200 Subject: [PATCH] Update .github/contributing/docs_guide.md Co-authored-by: Rich Churcher --- .github/contributing/docs_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/contributing/docs_guide.md b/.github/contributing/docs_guide.md index ba6f252ff383e..6019de58a7437 100644 --- a/.github/contributing/docs_guide.md +++ b/.github/contributing/docs_guide.md @@ -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.