From bb7d1b9b3aba2db5411bf90ac9e0c06929c59209 Mon Sep 17 00:00:00 2001 From: Ross Patterson Date: Mon, 11 Aug 2025 03:37:58 +0000 Subject: [PATCH] docs(start): Defining comments is discracting This one is squarely me with my editor's red pen, do what you will. I whole heartedly agree with this statement about comments and the intention (I assume) to encourage new users to comment their configurations early and often. I just think this isn't the right place for it and makes this document less focused and effective. --- .../source/guides/getting_started/first_sub.rst | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/docs/source/guides/getting_started/first_sub.rst b/docs/source/guides/getting_started/first_sub.rst index 7dd5c22f..e7bd02f6 100644 --- a/docs/source/guides/getting_started/first_sub.rst +++ b/docs/source/guides/getting_started/first_sub.rst @@ -54,21 +54,6 @@ which are used by the presets below. set at the same indentation level as ``overrides``, not within it. -------------------------------------- - -.. code-block:: yaml - :lineno-start: 6 - - # Can choose between: - # - Plex TV Show by Date: - # - Jellyfin TV Show by Date: - # - Kodi TV Show by Date: - # - -Lines 6-10 are comments that get ignored when parsing YAML since they are prefixed with ``#``. -It is good practice to leave informative comments in your config or subscription files to remind -yourself of various things. - ------------------------------------- .. code-block:: yaml @@ -138,4 +123,4 @@ Referring to the :ref:`TV show preset reference `, the first two indent variables map to the TV show genre and TV show content rating. -The above info should be enough to understand the rest of the subscription file. \ No newline at end of file +The above info should be enough to understand the rest of the subscription file.