From 23d0f082c23ac2d6bb57f86766e681b21d740341 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sun, 28 Aug 2022 00:16:15 -0700 Subject: [PATCH] docs updated --- src/ytdl_sub/plugins/nfo_tags.py | 80 +++++++++++-------- .../plugins/output_directory_nfo_tags.py | 16 ---- 2 files changed, 47 insertions(+), 49 deletions(-) diff --git a/src/ytdl_sub/plugins/nfo_tags.py b/src/ytdl_sub/plugins/nfo_tags.py index dcc370db..86a100bf 100644 --- a/src/ytdl_sub/plugins/nfo_tags.py +++ b/src/ytdl_sub/plugins/nfo_tags.py @@ -61,45 +61,14 @@ class SharedNfoTagsOptions( @property def nfo_root(self) -> StringFormatterValidator: """ - The root tag of the NFO's XML. In the usage above, it would look like - - .. code-block:: xml - - - - + OVERRIDE DOC IN CHILD CLASSES """ return self._nfo_root @property def tags(self) -> TSharedNfoTagsValidator: """ - Tags within the nfo_root tag. In the usage above, it would look like - - .. code-block:: xml - - - - Awesome Youtube Video - 2022 - 502 - - - Also supports xml attributes: - - .. code-block:: yaml - - tags: - season: - attributes: - name: "Best Year" - tag: "{upload_year}" - - Which translates to - - .. code-block:: xml - - 2022 + OVERRIDE DOC IN CHILD CLASSES """ return self._tags @@ -214,6 +183,51 @@ class NfoTagsOptions( _dict_formatter_validator = DictFormatterValidator _tags_validator = NfoTagsValidator + @property + def nfo_root(self) -> StringFormatterValidator: + """ + The root tag of the NFO's XML. In the usage above, it would look like + + .. code-block:: xml + + + + + """ + return self._nfo_root + + @property + def tags(self) -> NfoTagsValidator: + """ + Tags within the nfo_root tag. In the usage above, it would look like + + .. code-block:: xml + + + + Awesome Youtube Video + 2022 + 502 + + + Also supports xml attributes: + + .. code-block:: yaml + + tags: + season: + attributes: + name: "Best Year" + tag: "{upload_year}" + + Which translates to + + .. code-block:: xml + + 2022 + """ + return self._tags + class NfoTagsPlugin( SharedNfoTagsPlugin[StringFormatterValidator, DictFormatterValidator, NfoTagsValidator] diff --git a/src/ytdl_sub/plugins/output_directory_nfo_tags.py b/src/ytdl_sub/plugins/output_directory_nfo_tags.py index 85dbd20c..1ec87d03 100644 --- a/src/ytdl_sub/plugins/output_directory_nfo_tags.py +++ b/src/ytdl_sub/plugins/output_directory_nfo_tags.py @@ -37,13 +37,6 @@ class OutputDirectoryNfoTagsOptions( _dict_formatter_validator = OverridesDictFormatterValidator _tags_validator = NfoOverrideTagsValidator - @property - def nfo_name(self) -> OverridesStringFormatterValidator: - """ - The NFO file name. - """ - return self._nfo_name - @property def nfo_root(self) -> OverridesStringFormatterValidator: """ @@ -89,15 +82,6 @@ class OutputDirectoryNfoTagsOptions( """ return self._tags - @property - def kodi_safe(self) -> Optional[bool]: - """ - Optional. Kodi does not support > 3-byte unicode characters, which include emojis and some - foreign language characters. Setting this to True will replace those characters with '□'. - Defaults to False. - """ - return self._kodi_safe - class OutputDirectoryNfoTagsPlugin( SharedNfoTagsPlugin[