From 4c6a4ddd1c333e82e7342287ca3ffaf102327cb2 Mon Sep 17 00:00:00 2001
From: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com>
Date: Thu, 4 Apr 2024 14:19:03 +0400
Subject: [PATCH] chore: Add comments for translations

---
 .../layout/hide/comments/CommentsPatch.kt     |   7 +-
 .../resources/addresources/values/strings.xml | 123 ++++++++++++++----
 2 files changed, 101 insertions(+), 29 deletions(-)

diff --git a/src/main/kotlin/app/revanced/patches/youtube/layout/hide/comments/CommentsPatch.kt b/src/main/kotlin/app/revanced/patches/youtube/layout/hide/comments/CommentsPatch.kt
index 9cdb9c9b9..fdc90bf69 100644
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/hide/comments/CommentsPatch.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/hide/comments/CommentsPatch.kt
@@ -55,9 +55,10 @@ object CommentsPatch : ResourcePatch() {
             PreferenceScreen(
                 "revanced_comments_screen",
                 preferences = setOf(
-                    SwitchPreference("revanced_hide_comments_section"),
-                    SwitchPreference("revanced_hide_preview_comment")
-                )
+                    SwitchPreference("revanced_hide_preview_comment"),
+                    SwitchPreference("revanced_hide_comments_section")
+                ),
+                sorting = PreferenceScreen.Sorting.UNSORTED
             )
         )
 
diff --git a/src/main/resources/addresources/values/strings.xml b/src/main/resources/addresources/values/strings.xml
index 76390aec9..62e5dc3dc 100644
--- a/src/main/resources/addresources/values/strings.xml
+++ b/src/main/resources/addresources/values/strings.xml
@@ -13,9 +13,9 @@
             <string name="revanced_settings_import_failure_parse">Import failed: %s</string>
         </patch>
         <patch id="misc.gms.BaseGmsCoreSupportResourcePatch">
-            <!-- Translations of this should not be longer than what is here, otherwise the text can be clipped and not entirely shown. -->
+            <!-- Translations of this should not be longer than what is here or the text can be clipped and not entirely shown. -->
             <string name="gms_core_toast_not_installed_message">GmsCore is not installed. Install it.</string>
-            <!-- Translations of this should not be longer than what is here, otherwise the text can be clipped and not entirely shown. -->
+            <!-- Translations of this should not be longer than what is here or the text can be clipped and not entirely shown. -->
             <string name="gms_core_toast_not_whitelisted_message">Follow the \"Don\'t kill my app\" guide for GmsCore.</string>
             <string name="gms_core_dialog_title">Action needed</string>
             <string name="gms_core_dialog_not_whitelisted_using_battery_optimizations_message">GmsCore is not whitelisted from battery optimization.\n\nFollow the \"Don\'t kill my app\" guide for GmsCore.</string>
@@ -62,24 +62,30 @@
             <string name="revanced_hide_gray_separator_title">Hide gray separator</string>
             <string name="revanced_hide_gray_separator_summary_on">Gray separators are hidden</string>
             <string name="revanced_hide_gray_separator_summary_off">Gray separators are shown</string>
-            <string name="revanced_hide_join_membership_button_title">Hide \'Join\' button</string>
-            <string name="revanced_hide_join_membership_button_summary_on">Button is hidden</string>
-            <string name="revanced_hide_join_membership_button_summary_off">Button is shown</string>
             <string name="revanced_hide_channel_watermark_title">Hide channel watermark</string>
             <string name="revanced_hide_channel_watermark_summary_on">Watermark is hidden</string>
             <string name="revanced_hide_channel_watermark_summary_off">Watermark is shown</string>
+            <!-- 'Join' should be translated using the same localized wording YouTube displays.
+                 This appears in the video player for certain videos. -->
+            <string name="revanced_hide_join_membership_button_title">Hide \'Join\' button</string>
+            <string name="revanced_hide_join_membership_button_summary_on">Button is hidden</string>
+            <string name="revanced_hide_join_membership_button_summary_off">Button is shown</string>
+            <!-- 'For you' should be translated using the same localized wording YouTube displays. -->
             <string name="revanced_hide_for_you_shelf_title">Hide \'For you\' shelf in channel page</string>
             <string name="revanced_hide_for_you_shelf_summary_on">Shelf is hidden</string>
             <string name="revanced_hide_for_you_shelf_summary_off">Shelf is shown</string>
+            <!-- 'Notify me also watch' should be translated using the same localized wording YouTube displays.
+                 This item appear in the subscription feed for future livestreams or unreleased videos. -->
             <string name="revanced_hide_notify_me_button_title">Hide \'Notify me\' button</string>
             <string name="revanced_hide_notify_me_button_summary_on">Button is hidden</string>
             <string name="revanced_hide_notify_me_button_summary_off">Button is shown</string>
-            <string name="revanced_hide_timed_reactions_title">Hide timed reactions</string>
-            <string name="revanced_hide_timed_reactions_summary_on">Timed reactions are hidden</string>
-            <string name="revanced_hide_timed_reactions_summary_off">Timed reactions are shown</string>
+            <!-- 'People also watch' should be translated using the same localized wording YouTube displays. -->
             <string name="revanced_hide_search_result_recommendations_title">Hide \'People also watched\' recommendations</string>
             <string name="revanced_hide_search_result_recommendations_summary_on">Recommendations are hidden</string>
             <string name="revanced_hide_search_result_recommendations_summary_off">Recommendations are shown</string>
+            <string name="revanced_hide_timed_reactions_title">Hide timed reactions</string>
+            <string name="revanced_hide_timed_reactions_summary_on">Timed reactions are hidden</string>
+            <string name="revanced_hide_timed_reactions_summary_off">Timed reactions are shown</string>
             <string name="revanced_hide_search_result_shelf_header_title">Hide search result shelf header</string>
             <string name="revanced_hide_search_result_shelf_header_summary_on">Shelf header is hidden</string>
             <string name="revanced_hide_search_result_shelf_header_summary_off">Shelf header is shown</string>
@@ -186,11 +192,14 @@
             <string name="revanced_hide_keyword_content_search_summary_on">Search results are filtered by keywords</string>
             <string name="revanced_hide_keyword_content_search_summary_off">Search results are not filtered by keywords</string>
             <string name="revanced_hide_keyword_content_phrases_title">Keywords to hide</string>
+            <!-- For localization it is preferred, but not required, if 'LeBlanc' is replaced with a localized name 
+                 or familiar product name that has upper case letters in the middle of the word.
+                 This is because keywords can be in any language, and showing an example in the localized script helps convey this. -->
             <string name="revanced_hide_keyword_content_phrases_summary">Keywords and phrases to hide, separated by new lines\n\nWords with uppercase letters in the middle must be entered with the casing (ie: iPhone, TikTok, LeBlanc)</string>
             <string name="revanced_hide_keyword_content_about_title">About keyword filtering</string>
             <string name="revanced_hide_keyword_content_about_summary">Home/Subscription/Search results are filtered to hide content that matches keyword phrases\n\nLimitations\n• Some Shorts may not be hidden\n• Some UI components may not be hidden\n• Searching for a keyword may show no results</string>
             <string name="revanced_hide_keyword_toast_invalid_common">Invalid keyword. Cannot use: \'%s\' as a filter</string>
-            <string name="revanced_hide_keyword_toast_invalid_length">Invalid keyword. \'%1$s\' is less than %2$s characters</string>
+            <string name="revanced_hide_keyword_toast_invalid_length">Invalid keyword. \'%1$s\' is less than %2$d characters</string>
         </patch>
         <patch id="ad.general.HideAdsResourcePatch">
             <string name="revanced_hide_general_ads_title">Hide general ads</string>
@@ -199,7 +208,7 @@
             <string name="revanced_hide_fullscreen_ads_title">Hide fullscreen ads</string>
             <string name="revanced_hide_fullscreen_ads_summary_on">Fullscreen ads are hidden</string>
             <string name="revanced_hide_fullscreen_ads_summary_off">Fullscreen ads are shown</string>
-            <string name="revanced_hide_buttoned_ads_title">Hide buttoned ad</string>
+            <string name="revanced_hide_buttoned_ads_title">Hide buttoned ads</string>
             <string name="revanced_hide_buttoned_ads_summary_on">Buttoned ads are hidden</string>
             <string name="revanced_hide_buttoned_ads_summary_off">Buttoned ads are shown</string>
             <string name="revanced_hide_paid_content_ads_title">Hide paid content</string>
@@ -220,7 +229,7 @@
             <string name="revanced_hide_merchandise_banners_title">Hide merchandise banners</string>
             <string name="revanced_hide_merchandise_banners_summary_on">Merchandise banners are hidden</string>
             <string name="revanced_hide_merchandise_banners_summary_off">Merchandise banners are shown</string>
-            <string name="revanced_hide_fullscreen_ads_feature_not_available_toast">Failed to hide full-screen ad. Disabling to prevent issues</string>
+            <string name="revanced_hide_fullscreen_ads_feature_not_available_toast">Could not hide fullscreen ad. Hide setting disabled to prevent issues.</string>
         </patch>
         <patch id="ad.getpremium.HideGetPremiumPatch">
             <string name="revanced_hide_get_premium_title">Hide YouTube Premium promotions</string>
@@ -254,6 +263,7 @@
             <string name="revanced_external_downloader_title">Show external download button</string>
             <string name="revanced_external_downloader_summary_on">Download button shown in player</string>
             <string name="revanced_external_downloader_summary_off">Download button not shown in player</string>
+            <!-- 'download action button' should be translated using the same wording as the translation of 'revanced_hide_download_button_title' -->
             <string name="revanced_external_downloader_action_button_title">Override download action button</string>
             <string name="revanced_external_downloader_action_button_summary_on">Download button opens your external downloader</string>
             <string name="revanced_external_downloader_action_button_summary_off">Download button opens the native in-app downloader</string>
@@ -307,27 +317,38 @@
             <string name="revanced_hide_like_dislike_button_title">Hide Like and Dislike</string>
             <string name="revanced_hide_like_dislike_button_summary_on">Like and Dislike buttons are hidden</string>
             <string name="revanced_hide_like_dislike_button_summary_off">Like and Dislike buttons are shown</string>
+            <!-- 'Share' should be translated with the same localized wording that YouTube displays. -->
             <string name="revanced_hide_share_button_title">Hide Share</string>
             <string name="revanced_hide_share_button_summary_on">Share button is hidden</string>
             <string name="revanced_hide_share_button_summary_off">Share button is shown</string>
+            <!-- 'Report' should be translated with the same localized wording that YouTube displays.
+                 This button usually appears only on live streams. -->
             <string name="revanced_hide_report_button_title">Hide Report</string>
             <string name="revanced_hide_report_button_summary_on">Report button is hidden</string>
             <string name="revanced_hide_report_button_summary_off">Report button is shown</string>
+            <!-- 'Remix' should be translated with the same localized wording that YouTube displays. -->
             <string name="revanced_hide_remix_button_title">Hide Remix</string>
             <string name="revanced_hide_remix_button_summary_on">Remix button is hidden</string>
             <string name="revanced_hide_remix_button_summary_off">Remix button is shown</string>
+            <!-- 'Download' should be translated with the same localized wording that YouTube displays. -->
             <string name="revanced_hide_download_button_title">Hide Download</string>
             <string name="revanced_hide_download_button_summary_on">Download button is hidden</string>
             <string name="revanced_hide_download_button_summary_off">Download button is shown</string>
+            <!-- 'Thanks' should be translated with the same localized wording that YouTube displays. -->
             <string name="revanced_hide_thanks_button_title">Hide Thanks</string>
             <string name="revanced_hide_thanks_button_summary_on">Thanks button is hidden</string>
             <string name="revanced_hide_thanks_button_summary_off">Thanks button is shown</string>
+            <!-- 'Clip' should be translated with the same localized wording that YouTube displays. -->
             <string name="revanced_hide_clip_button_title">Hide Clip</string>
             <string name="revanced_hide_clip_button_summary_on">Clip button is hidden</string>
             <string name="revanced_hide_clip_button_summary_off">Clip button is shown</string>
+            <!-- 'Save' should be translated with the same localized wording that YouTube displays. -->
             <string name="revanced_hide_playlist_button_title">Hide Save to playlist</string>
             <string name="revanced_hide_playlist_button_summary_on">Save to playlist button is hidden</string>
             <string name="revanced_hide_playlist_button_summary_off">Save to playlist button is shown</string>
+            <!-- 'Shop' should be translated with the same localized wording that YouTube displays.
+                 Shop button appears only for some videos in certain regions.
+                 Translate the button name normally if this menu is never shown. -->
             <string name="revanced_hide_shop_button_title">Hide Shop</string>
             <string name="revanced_hide_shop_button_summary_on">Shop button is hidden</string>
             <string name="revanced_hide_shop_button_summary_off">Shop button is shown</string>
@@ -338,6 +359,8 @@
             <string name="revanced_hide_autoplay_button_summary_off">Autoplay button is shown</string>
         </patch>
         <patch id="layout.buttons.captions.HideCaptionsButtonPatch">
+            <!-- This button does not display any text, but 'captions' should be translated using
+                 the same wording used as the translation of 'revanced_hide_player_flyout_captions_title' -->
             <string name="revanced_hide_captions_button_title">Hide captions button</string>
             <string name="revanced_hide_captions_button_summary_on">Captions button is hidden</string>
             <string name="revanced_hide_captions_button_summary_off">Captions button is shown</string>
@@ -350,18 +373,23 @@
         <patch id="layout.buttons.navigation.NavigationButtonsPatch">
             <string name="revanced_navigation_buttons_screen_title">Navigation buttons</string>
             <string name="revanced_navigation_buttons_screen_summary">Hide or change buttons in the navigation bar</string>
+            <!-- 'Home' should be translated using the same localized wording YouTube displays for the tab. -->
             <string name="revanced_hide_home_button_title">Hide Home</string>
             <string name="revanced_hide_home_button_summary_on">Home button is hidden</string>
             <string name="revanced_hide_home_button_summary_off">Home button is shown</string>
+            <!-- 'Shorts' should be translated using the same localized wording YouTube displays the tab. -->
             <string name="revanced_hide_shorts_button_title">Hide Shorts</string>
             <string name="revanced_hide_shorts_button_summary_on">Shorts button is hidden</string>
             <string name="revanced_hide_shorts_button_summary_off">Shorts button is shown</string>
+            <!-- The Create button has no display name. Translate normally. -->
             <string name="revanced_hide_create_button_title">Hide Create</string>
             <string name="revanced_hide_create_button_summary_on">Create button is hidden</string>
             <string name="revanced_hide_create_button_summary_off">Create button is shown</string>
+            <!-- 'Subscriptions' should be translated using the same localized wording YouTube displays the tab. -->
             <string name="revanced_hide_subscriptions_button_title">Hide Subscriptions</string>
             <string name="revanced_hide_subscriptions_button_summary_on">Subscriptions button is hidden</string>
             <string name="revanced_hide_subscriptions_button_summary_off">Subscriptions button is shown</string>
+            <!-- 'Notifications' should be translated using the same localized wording YouTube displays the tab. -->
             <string name="revanced_switch_create_with_notifications_button_title">Switch Create with Notifications</string>
             <string name="revanced_switch_create_with_notifications_button_summary_on">Create button is switched with Notifications button</string>
             <string name="revanced_switch_create_with_notifications_button_summary_off">Create button is not switched with Notifications button</string>
@@ -369,36 +397,49 @@
         <patch id="layout.hide.player.flyoutmenupanel.HidePlayerFlyoutMenuPatch">
             <string name="revanced_hide_player_flyout_title">Flyout menu</string>
             <string name="revanced_hide_player_flyout_summary">Hide or show player flyout menu items</string>
+            <!-- 'Captions' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_captions_title">Hide Captions</string>
             <string name="revanced_hide_player_flyout_captions_summary_on">Captions menu is hidden</string>
             <string name="revanced_hide_player_flyout_captions_summary_off">Captions menu is shown</string>
+            <!-- 'Additional settings' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_additional_settings_title">Hide Additional settings</string>
             <string name="revanced_hide_player_flyout_additional_settings_summary_on">Additional settings menu is hidden</string>
             <string name="revanced_hide_player_flyout_additional_settings_summary_off">Additional settings menu is shown</string>
+            <!-- 'Loop video' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_loop_video_title">Hide Loop video</string>
             <string name="revanced_hide_player_flyout_loop_video_summary_on">Loop video menu is hidden</string>
             <string name="revanced_hide_player_flyout_loop_video_summary_off">Loop video menu is shown</string>
+            <!-- 'Ambient mode' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_ambient_mode_title">Hide Ambient mode</string>
             <string name="revanced_hide_player_flyout_ambient_mode_summary_on">Ambient mode menu is hidden</string>
             <string name="revanced_hide_player_flyout_ambient_mode_summary_off">Ambient mode menu is shown</string>
+            <!-- 'Report' should be translated using the same localized wording YouTube displays for the menu item.
+                 This item may not appear in some regions. Translate the name normally if the menu cannot be found. -->
             <string name="revanced_hide_player_flyout_report_title">Hide Report</string>
             <string name="revanced_hide_player_flyout_report_summary_on">Report menu is hidden</string>
             <string name="revanced_hide_player_flyout_report_summary_off">Report menu is shown</string>
+            <!-- 'Help & feedback' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_help_title">Hide Help &amp; feedback</string>
             <string name="revanced_hide_player_flyout_help_summary_on">Help &amp; feedback menu is hidden</string>
             <string name="revanced_hide_player_flyout_help_summary_off">Help &amp; feedback menu is shown</string>
+            <!-- 'Playback speed' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_speed_title">Hide Playback speed</string>
             <string name="revanced_hide_player_flyout_speed_summary_on">Playback speed menu is hidden</string>
             <string name="revanced_hide_player_flyout_speed_summary_off">Playback speed menu is shown</string>
+            <!-- 'More info' should be translated using the same localized wording YouTube displays for the menu item.
+                 This menu only appears for some videos. Translate the name normally if the menu cannot be found. -->
             <string name="revanced_hide_player_flyout_more_info_title">Hide More info</string>
             <string name="revanced_hide_player_flyout_more_info_summary_on">More info menu is hidden</string>
             <string name="revanced_hide_player_flyout_more_info_summary_off">More info menu is shown</string>
+            <!-- 'Lock screen' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_lock_screen_title">Hide Lock screen</string>
             <string name="revanced_hide_player_flyout_lock_screen_summary_on">Lock screen menu is hidden</string>
             <string name="revanced_hide_player_flyout_lock_screen_summary_off">Lock screen menu is shown</string>
+            <!-- 'Audio track' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_audio_track_title">Hide Audio track</string>
             <string name="revanced_hide_player_flyout_audio_track_summary_on">Audio track menu is hidden</string>
             <string name="revanced_hide_player_flyout_audio_track_summary_off">Audio track menu is shown</string>
+            <!-- 'Watch in VR' should be translated using the same localized wording YouTube displays for the menu item. -->
             <string name="revanced_hide_player_flyout_watch_in_vr_title">Hide Watch in VR</string>
             <string name="revanced_hide_player_flyout_watch_in_vr_summary_on">Watch in VR menu is hidden</string>
             <string name="revanced_hide_player_flyout_watch_in_vr_summary_off">Watch in VR menu is shown</string>
@@ -421,12 +462,12 @@
         <patch id="layout.hide.comments.CommentsPatch">
             <string name="revanced_comments_screen_title">Comments</string>
             <string name="revanced_comments_screen_summary">Hide or show comments section components</string>
-            <string name="revanced_hide_comments_section_title">Hide comments section</string>
-            <string name="revanced_hide_comments_section_summary_on">Comment section is hidden</string>
-            <string name="revanced_hide_comments_section_summary_off">Comment section is shown</string>
             <string name="revanced_hide_preview_comment_title">Hide preview comment</string>
             <string name="revanced_hide_preview_comment_summary_on">Preview comment is hidden</string>
             <string name="revanced_hide_preview_comment_summary_off">Preview comment is shown</string>
+            <string name="revanced_hide_comments_section_title">Hide comments section</string>
+            <string name="revanced_hide_comments_section_summary_on">Comment section is hidden</string>
+            <string name="revanced_hide_comments_section_summary_off">Comment section is shown</string>
         </patch>
         <patch id="layout.hide.crowdfundingbox.CrowdfundingBoxResourcePatch">
             <string name="revanced_hide_crowdfunding_box_title">Hide crowdfunding box</string>
@@ -467,6 +508,8 @@
             <string name="revanced_hide_info_cards_summary_off">Info cards are shown</string>
         </patch>
         <patch id="layout.hide.loadmorebutton.HideLoadMoreButtonResourcePatch">
+            <!-- 'Load more' should be translated with the same localized wording that YouTube displays. 
+                 This commonly appears when searching for a YT creator. -->
             <string name="revanced_hide_load_more_button_title">Hide \'Load More\' button</string>
             <string name="revanced_hide_load_more_button_summary_on">Button is hidden</string>
             <string name="revanced_hide_load_more_button_summary_off">Button is shown</string>
@@ -488,21 +531,27 @@
             <string name="revanced_hide_shorts_home_title">Hide Shorts in home feed</string>
             <string name="revanced_hide_shorts_home_summary_on">Shorts in home feed are hidden</string>
             <string name="revanced_hide_shorts_home_summary_off">Shorts in home feed are shown</string>
+            <!-- 'subscription' should be translated using the same localized wording YouTube displays for the subscription tab. -->
             <string name="revanced_hide_shorts_subscriptions_title">Hide Shorts in subscription feed</string>
             <string name="revanced_hide_shorts_subscriptions_summary_on">Shorts in subscription feed are hidden</string>
             <string name="revanced_hide_shorts_subscriptions_summary_off">Shorts in subscription feed are shown</string>
             <string name="revanced_hide_shorts_search_title">Hide Shorts in search results</string>
             <string name="revanced_hide_shorts_search_summary_on">Shorts in search results are hidden</string>
             <string name="revanced_hide_shorts_search_summary_off">Shorts in search results are shown</string>
+            <!-- 'join' should be translated using the same localized wording YouTube displays for the button. -->
             <string name="revanced_hide_shorts_join_button_title">Hide join button</string>
             <string name="revanced_hide_shorts_join_button_summary_on">Join button is hidden</string>
             <string name="revanced_hide_shorts_join_button_summary_off">Join button is shown</string>
+            <!-- 'subscribe' should be translated using the same localized wording YouTube displays for the button. -->
             <string name="revanced_hide_shorts_subscribe_button_title">Hide subscribe button</string>
             <string name="revanced_hide_shorts_subscribe_button_summary_on">Subscribe button is hidden</string>
             <string name="revanced_hide_shorts_subscribe_button_summary_off">Subscribe button is shown</string>
+            <!-- 'subscribe' should be translated using the same localized wording YouTube displays for the button. -->
             <string name="revanced_hide_shorts_subscribe_button_paused_title">Hide subscribe button when paused</string>
             <string name="revanced_hide_shorts_subscribe_button_paused_summary_on">Subscribe button is hidden</string>
             <string name="revanced_hide_shorts_subscribe_button_paused_summary_off">Subscribe button is shown</string>
+            <!-- 'thanks' should be translated using the same localized wording YouTube displays for the button. 
+                 If the button never shows up, then translate the button name normally. -->
             <string name="revanced_hide_shorts_thanks_button_title">Hide thanks button</string>
             <string name="revanced_hide_shorts_thanks_button_summary_on">Thanks button is hidden</string>
             <string name="revanced_hide_shorts_thanks_button_summary_off">Thanks button is shown</string>
@@ -515,9 +564,11 @@
             <string name="revanced_hide_shorts_comments_button_title">Hide comments button</string>
             <string name="revanced_hide_shorts_comments_button_summary_on">Comments button is hidden</string>
             <string name="revanced_hide_shorts_comments_button_summary_off">Comments button is shown</string>
+            <!-- 'remix' should be translated using the same localized wording YouTube displays for the button. -->
             <string name="revanced_hide_shorts_remix_button_title">Hide remix button</string>
             <string name="revanced_hide_shorts_remix_button_summary_on">Remix button is hidden</string>
             <string name="revanced_hide_shorts_remix_button_summary_off">Remix button is shown</string>
+            <!-- 'share' should be translated using the same localized wording YouTube displays for the button. -->
             <string name="revanced_hide_shorts_share_button_title">Hide share button</string>
             <string name="revanced_hide_shorts_share_button_summary_on">Share button is hidden</string>
             <string name="revanced_hide_shorts_share_button_summary_off">Share button is shown</string>
@@ -531,11 +582,11 @@
             <string name="revanced_hide_shorts_video_title_summary_on">Title is hidden</string>
             <string name="revanced_hide_shorts_video_title_summary_off">Title is shown</string>
             <string name="revanced_hide_shorts_sound_metadata_label_title">Hide sound metadata label</string>
-            <string name="revanced_hide_shorts_sound_metadata_label_summary_on">Label is hidden</string>
-            <string name="revanced_hide_shorts_sound_metadata_label_summary_off">Label is shown</string>
+            <string name="revanced_hide_shorts_sound_metadata_label_summary_on">Metadata label is hidden</string>
+            <string name="revanced_hide_shorts_sound_metadata_label_summary_off">Metadata label is shown</string>
             <string name="revanced_hide_shorts_full_video_link_label_title">Hide full video link label</string>
-            <string name="revanced_hide_shorts_full_video_link_label_summary_on">Label is hidden</string>
-            <string name="revanced_hide_shorts_full_video_link_label_summary_off">Label is shown</string>
+            <string name="revanced_hide_shorts_full_video_link_label_summary_on">Video link label is hidden</string>
+            <string name="revanced_hide_shorts_full_video_link_label_summary_off">Video link label is shown</string>
             <string name="revanced_hide_shorts_sound_button_title">Hide sound button</string>
             <string name="revanced_hide_shorts_sound_button_summary_on">Sound button is hidden</string>
             <string name="revanced_hide_shorts_sound_button_summary_off">Sound button is shown</string>
@@ -565,23 +616,28 @@
         <patch id="layout.returnyoutubedislike.ReturnYouTubeDislikeResourcePatch">
             <string name="revanced_ryd_settings_title">Return YouTube Dislike</string>
             <string name="revanced_ryd_video_likes_hidden_by_video_owner">Hidden</string>
+            <!-- Toast shown if network connection times out. Translations of this should not be longer
+                 than the original English or the text can be clipped and not entirely shown. -->
             <string name="revanced_ryd_failure_connection_timeout">Dislikes temporarily not available (API timed out)</string>
             <string name="revanced_ryd_failure_connection_status_code">Dislikes not available (status %d)</string>
             <string name="revanced_ryd_failure_client_rate_limit_requested">Dislikes not available (client API limit reached)</string>
             <string name="revanced_ryd_failure_generic">Dislikes not available (%s)</string>
-            <!-- corner case situation, where user enables RYD while video is playing and then tries to vote for the video -->
+            <!-- Toast shown if the user enables RYD while a video is opened, and then tries to vote for the video. -->
             <string name="revanced_ryd_failure_ryd_enabled_while_playing_video_then_user_voted">Reload video to vote using ReturnYouTubeDislike</string>
             <string name="revanced_ryd_enable_title">Return YouTube Dislike</string>
             <string name="revanced_ryd_enable_summary_on">Dislikes are shown</string>
             <string name="revanced_ryd_enable_summary_off">Dislikes are not shown</string>
             <string name="revanced_ryd_shorts_title">Show dislikes on Shorts</string>
-            <!-- The %s string is either 'revanced_ryd_shorts_summary_disclaimer', or it is an empty string. This text should read normally in both situations. -->
+            <!-- %s is either an empty blank string, or it is 'revanced_ryd_shorts_summary_disclaimer'.
+                 This text should read normally in both situations. -->
             <string name="revanced_ryd_shorts_summary_on">Dislikes shown on Shorts %s</string>
             <string name="revanced_ryd_shorts_summary_off">Dislikes hidden on Shorts</string>
+            <!-- Shown only when used with 'revanced_ryd_shorts_summary_on' and it is never displayed alone. -->
             <string name="revanced_ryd_shorts_summary_disclaimer">Limitation: Dislikes may not appear in incognito mode</string>
             <string name="revanced_ryd_dislike_percentage_title">Dislikes as percentage</string>
             <string name="revanced_ryd_dislike_percentage_summary_on">Dislikes shown as percentage</string>
             <string name="revanced_ryd_dislike_percentage_summary_off">Dislikes shown as number</string>
+            <!-- Translations should use language similar to 'revanced_sb_enable_compact_skip_button' -->
             <string name="revanced_ryd_compact_layout_title">Compact like button</string>
             <string name="revanced_ryd_compact_layout_summary_on">Like button styled for minimum width</string>
             <string name="revanced_ryd_compact_layout_summary_off">Like button styled for best appearance</string>
@@ -591,7 +647,7 @@
             <string name="revanced_ryd_about">About</string>
             <string name="revanced_ryd_attribution_title">ReturnYouTubeDislike.com</string>
             <string name="revanced_ryd_attribution_summary">Data is provided by the Return YouTube Dislike API. Tap here to learn more</string>
-            <!-- Statistic strings are shown in the settings only when ReVanced debug mode is enabled. Typical users will never see these statistics. -->
+            <!-- Statistic strings are shown in the settings only when ReVanced debug mode is enabled. Typical users will never see these. -->
             <string name="revanced_ryd_statistics_category_title">ReturnYouTubeDislike API statistics of this device</string>
             <string name="revanced_ryd_statistics_getFetchCallResponseTimeAverage_title">API response time, average</string>
             <string name="revanced_ryd_statistics_getFetchCallResponseTimeMin_title">API response time, minimum</string>
@@ -627,6 +683,7 @@
             <string name="revanced_sb_enable_voting">Show voting button</string>
             <string name="revanced_sb_enable_voting_sum_on">Segment voting button is shown</string>
             <string name="revanced_sb_enable_voting_sum_off">Segment voting button is not shown</string>
+            <!-- Translations should use language similar to 'revanced_ryd_compact_layout_title' -->
             <string name="revanced_sb_enable_compact_skip_button">Use compact skip button</string>
             <string name="revanced_sb_enable_compact_skip_button_sum_on">Skip button styled for minimum width</string>
             <string name="revanced_sb_enable_compact_skip_button_sum_off">Skip button styled for best appearance</string>
@@ -671,7 +728,10 @@
             <string name="revanced_sb_api_url_changed">API URL changed</string>
             <string name="revanced_sb_settings_ie">Import/Export settings</string>
             <string name="revanced_sb_settings_copy">Copy</string>
+            <!-- %s is either an empty blank string, or it is 'revanced_sb_settings_ie_sum_warning'.
+                 This text should read normally in both situations. -->
             <string name="revanced_sb_settings_ie_sum">Your SponsorBlock JSON configuration that can be imported/exported to ReVanced and other SponsorBlock platforms %s</string>
+            <!-- Shown only when used with 'revanced_sb_settings_ie_sum' and it is never displayed alone. -->
             <string name="revanced_sb_settings_ie_sum_warning">This includes your private user id. Be sure to share this wisely</string>
             <string name="revanced_sb_settings_import_successful">Settings imported successfully</string>
             <string name="revanced_sb_settings_import_failed">Failed to import: %s</string>
@@ -740,9 +800,11 @@
             <string name="revanced_sb_submit_failed_forbidden">Can\'t submit the segment: %s</string>
             <string name="revanced_sb_submit_failed_duplicate">Can\'t submit the segment.\nAlready exists</string>
             <string name="revanced_sb_submit_succeeded">Segment submitted successfully</string>
-            <string name="revanced_sb_sponsorblock_connection_failure_generic">SponsorBlock temporarily not available</string>
-            <string name="revanced_sb_sponsorblock_connection_failure_status">SponsorBlock temporarily not available (status %d)</string>
+            <!-- Toast shown if network connection times out. Translations of this should not be longer
+                 than the original English or the text can be clipped and not entirely shown. -->
             <string name="revanced_sb_sponsorblock_connection_failure_timeout">SponsorBlock temporarily not available (API timed out)</string>
+            <string name="revanced_sb_sponsorblock_connection_failure_status">SponsorBlock temporarily not available (status %d)</string>
+            <string name="revanced_sb_sponsorblock_connection_failure_generic">SponsorBlock temporarily not available</string>
             <string name="revanced_sb_vote_failed_timeout">Unable to vote for segment (API timed out)</string>
             <string name="revanced_sb_vote_failed_unknown_error">Unable to vote for segment (status: %1$d %2$s)</string>
             <string name="revanced_sb_vote_failed_forbidden">Unable to vote for segment: %s</string>
@@ -768,6 +830,7 @@
             <string name="revanced_sb_new_segment_edit_by_hand_content">Do you want to edit the timing for the start or end of the segment?</string>
             <string name="revanced_sb_new_segment_edit_by_hand_parse_error">Invalid time given</string>
             <string name="revanced_sb_stats">Stats</string>
+            <!-- Shown in the settings preferences, and translations can be any text length. -->
             <string name="revanced_sb_stats_connection_failure">Stats temporarily not available (API is down)</string>
             <string name="revanced_sb_stats_loading">Loading...</string>
             <string name="revanced_sb_stats_sb_disabled">SponsorBlock is disabled</string>
@@ -805,7 +868,7 @@
             <!-- It is ideal, but not required, if the text here appears alphabetically after the text used for 'revanced_spoof_app_version_title'.
                  This is because the 'General layout' menu uses alphabetic sorting, and it functionally works better if the spoof target selector appears below the 'Spoof app version' UI switch -->
             <string name="revanced_spoof_app_version_target_title">Spoof app version target</string>
-            <!-- 'RYD' is referring to 'Return YouTube Dislike' -->
+            <!-- 'RYD' is 'Return YouTube Dislike' -->
             <string name="revanced_spoof_app_version_target_entry_1">18.33.40 - Restore RYD on Shorts incognito mode</string>
             <string name="revanced_spoof_app_version_target_entry_2">18.20.39 - Restore wide video speed &amp; quality menu</string>
             <string name="revanced_spoof_app_version_target_entry_3">18.09.39 - Restore library tab</string>
@@ -815,13 +878,17 @@
         <patch id="layout.startpage.ChangeStartPagePatch">
             <string name="revanced_start_page_title">Set start page</string>
             <string name="revanced_start_page_entry_0">Default</string>
+            <!-- 'Home' should be translated using the same localized wording YouTube displays for the home tab. -->
             <string name="revanced_start_page_entry_1">Home</string>
             <string name="revanced_start_page_entry_2">Search</string>
+            <!-- 'Subscriptions' should be translated using the same localized wording YouTube displays for the subscriptions tab. -->
             <string name="revanced_start_page_entry_3">Subscriptions</string>
             <string name="revanced_start_page_entry_4">Explore</string>
             <string name="revanced_start_page_entry_5">Shorts</string>
-            <string name="revanced_start_page_entry_6">Library</string>
+            <!-- 'You' should be translated using the same localized wording YouTube displays for the You (library) tab. -->
+            <string name="revanced_start_page_entry_6">You tab</string>
             <string name="revanced_start_page_entry_7">Liked videos</string>
+            <!-- 'History' should be translated using the same localized wording YouTube displays for the 'history' section in the 'You' tab. -->
             <string name="revanced_start_page_entry_8">History</string>
             <string name="revanced_start_page_entry_9">Trending</string>
         </patch>
@@ -855,8 +922,11 @@
             <string name="revanced_seekbar_custom_color_invalid">Invalid seekbar color value. Using default value.</string>
         </patch>
         <patch id="layout.thumbnails.AlternativeThumbnailsPatch">
+            <!-- 'Home' should be translated using the same localized wording YouTube displays for the home tab. -->
             <string name="revanced_alt_thumbnail_home_title">Home tab</string>
+            <!-- 'Subscription' should be translated using the same localized wording YouTube displays for the subscription tab. -->
             <string name="revanced_alt_thumbnail_subscription_title">Subscription tab</string>
+            <!-- 'You' should be translated using the same localized wording YouTube displays for the You (library) tab. -->
             <string name="revanced_alt_thumbnail_library_title">You tab</string>
             <string name="revanced_alt_thumbnail_player_title">Player playlists, recommendations</string>
             <string name="revanced_alt_thumbnail_search_title">Search results</string>
@@ -901,7 +971,7 @@
             <string name="revanced_spoof_device_dimensions_summary_on">Device dimensions spoofed</string>
             <string name="revanced_spoof_device_dimensions_summary_off">Device dimensions not spoofed\n\nSpoofing the device dimensions can unlock higher video qualities but unknown side effects may occur</string>
         </patch>
-        <!-- This patch is no longer used, these strings are not in use, and these strings likely will be deleted in the future. -->
+        <!-- This patch is no longer used, these strings are not in use, and these strings will be deleted in the future. -->
         <patch id="misc.fix.playback.SpoofSignaturePatch">
             <string name="revanced_spoof_signature_verification_screen_title">Spoof app signature</string>
             <string name="revanced_spoof_signature_verification_screen_summary">Spoof the app signature to prevent playback issues</string>
@@ -1027,6 +1097,7 @@
             <string name="revanced_auto_claim_channel_points_summary_off">Channel Points are not claimed automatically</string>
         </patch>
         <patch id="debug.DebugModePatch">
+            <!-- Twitch specific internal debug mode, and not the same as 'revanced_debug_title' -->
             <string name="revanced_twitch_debug_mode_title">Enable Twitch debug mode</string>
             <string name="revanced_twitch_debug_mode_summary_on">Twitch debug mode is enabled (not recommended)</string>
             <string name="revanced_twitch_debug_mode_summary_off">Twitch debug mode is disabled</string>