danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(start): Defining comments is discracting

Browse source 
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.
This commit is contained in:
Ross Patterson 2025-08-11 03:37:58 +00:00
parent 25e6946563
commit bb7d1b9b3a
No known key found for this signature in database
GPG key ID: 2EFF7CCE6828E359
1 changed files with 1 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/source/guides/getting_started/first_sub.rst
View file

@ -54,21 +54,6 @@ which are used by the presets below.
set at the same indentation level as ``overrides``, not within it. 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 .. code-block:: yaml