From ce3f414803e8ba1721a6d707e83990542b470edc Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Fri, 10 Nov 2023 10:23:55 +1300 Subject: [PATCH] DOC Document how to include filenames for code blocks --- en/05_Contributing/02_Documentation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/en/05_Contributing/02_Documentation.md b/en/05_Contributing/02_Documentation.md index 84eb9deef..adc312f40 100644 --- a/en/05_Contributing/02_Documentation.md +++ b/en/05_Contributing/02_Documentation.md @@ -111,6 +111,8 @@ documenting, there shouldn't be any "frequently asked questions" left. - Use an empty line to separate paragraphs. - Sentence case your bullet points. If a bullet point is a full sentence then end with a full stop. If it is a sentence fragment or a comma separated list, full stops are not required. - All code blocks must have an appropriate syntax highlighting hint. For plain text, use "text". +- If it's useful to include the filename that a code block relates to, do so in a comment in the first line of the code block. + - Don't place a blank line after this comment, unless the next line is also a comment. - Code examples should follow our [coding conventions](./coding_conventions). - Use `App` when the code requires a vendor name (e.g. as the root for namespaces). - Do not put a `$` in front of lines of bash code examples.