From fc7c8bce309496ce6819163fff79d5fd4c0e53bf Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Fri, 23 Apr 2021 16:32:04 -0500 Subject: [PATCH] docs(wiki): Add optional to guidelines Explain how optional works in the trash guide structural guidelines --- wiki/TRaSH-Guide-Structural-Guidelines.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/wiki/TRaSH-Guide-Structural-Guidelines.md b/wiki/TRaSH-Guide-Structural-Guidelines.md index ba9d7398..deebb756 100644 --- a/wiki/TRaSH-Guide-Structural-Guidelines.md +++ b/wiki/TRaSH-Guide-Structural-Guidelines.md @@ -90,6 +90,19 @@ The following general rules apply to all lines in the markdown data: This is optional and the default is always "UNCHECKED". +1. **Terms may be marked "optional".** + + From a header or sentence within a header section, the appearance of the word "optional" will + indicate that certain terms will *not* be synchronized to Sonarr by default. The semantics for + this differ depending on where the word is mentioned: + + - **Headers**: "Optional" mentioned in a header will apply to all code blocks in that whole + section. Furthermore, any nested headers will also be treated as if the word "Optional" appears + in its name, even if it isn't. + - **Sentence**: Once the term "Optional" is found in any sentence following a header, it applies + to all code blocks for the remainder of that section. Once a new header is found (nested or + not), terms are not considered optional anymore. + ### Release Profile Naming The script procedurally generates a name for release profiles it creates. For the following example: