From e6412631ae76dded9ab4ee6282011ed9f7614893 Mon Sep 17 00:00:00 2001 From: Piradata <16529503+piradata@users.noreply.github.com> Date: Tue, 31 Dec 2024 19:06:53 -0300 Subject: [PATCH] correct some typos --- fastanime/cli/config.py | 185 ++++++++++++++++++++-------------------- 1 file changed, 91 insertions(+), 94 deletions(-) diff --git a/fastanime/cli/config.py b/fastanime/cli/config.py index 1a35e1a..1f610f9 100644 --- a/fastanime/cli/config.py +++ b/fastanime/cli/config.py @@ -279,114 +279,114 @@ class Config(object): # [general] # Can you rice it? -# for the preview pane +# For the preview pane preview_separator_color = {self.preview_separator_color} preview_header_color = {self.preview_header_color} -# for the header -# be sure to indent -header_ascii_art = {new_line.join([tab+line for line in self.header_ascii_art.split(new_line)])} +# For the header +# Be sure to indent +header_ascii_art = {new_line.join([tab + line for line in self.header_ascii_art.split(new_line)])} header_color = {self.header_color} -# to be passed to fzf -# be sure to indent -fzf_opts = {new_line.join([tab+line for line in self.fzf_opts.split(new_line)])} +# To be passed to fzf +# Be sure to indent +fzf_opts = {new_line.join([tab + line for line in self.fzf_opts.split(new_line)])} -# whether to show the icons in the tui [True/False] -# more like emojis -# by the way if you have any recommendations -# to which should be used where please +# Whether to show the icons in the TUI [True/False] +# More like emojis +# By the way, if you have any recommendations +# for which should be used where, please # don't hesitate to share your opinion -# cause it's a lot of work +# because it's a lot of work # to look for the right one for each menu option -# be sure to also give the replacement emoji +# Be sure to also give the replacement emoji icons = {self.icons} -# whether to normalize provider titles [True/False] -# basically takes the provider titles and finds the corresponding anilist title then changes the title to that -# useful for uniformity especially when downloading from different providers -# this also applies to episode titles +# Whether to normalize provider titles [True/False] +# Basically takes the provider titles and finds the corresponding Anilist title, then changes the title to that +# Useful for uniformity, especially when downloading from different providers +# This also applies to episode titles normalize_titles = {self.normalize_titles} -# whether to check for updates every time you run the script [True/False] -# this is useful for keeping your script up to date -# cause there are always new features being added ๐Ÿ˜„ +# Whether to check for updates every time you run the script [True/False] +# This is useful for keeping your script up to date +# because there are always new features being added ๐Ÿ˜„ check_for_updates = {self.check_for_updates} -# can be [allanime, animepahe, hianime, nyaa, yugen] -# allanime is the most realible -# animepahe provides different links to streams of different quality so a quality can be selected reliably with --quality option -# hianime usually provides subs in different languuages and its servers are generally faster -# NOTE: currently they are encrypting the video links -# though am working on it -# however, you can still get the links to the subs +# Can be [allanime, animepahe, hianime, nyaa, yugen] +# Allanime is the most reliable +# Animepahe provides different links to streams of different quality, so a quality can be selected reliably with the --quality option +# Hianime usually provides subs in different languages, and its servers are generally faster +# NOTE: Currently, they are encrypting the video links +# though Iโ€™m working on it +# However, you can still get the links to the subs # with ```fastanime grab``` command -# yugen meh -# nyaa those who prefer torrents, though not reliable due to auto selection of results -# as most of the data in nyaa is not structured -# though works relatively well for new anime -# esp with subsplease and horriblesubs -# oh and you should have webtorrent cli to use this +# Yugen meh +# Nyaa for those who prefer torrents, though not reliable due to auto-selection of results +# as most of the data in Nyaa is not structured +# though it works relatively well for new anime +# especially with SubsPlease and HorribleSubs +# Oh, and you should have webtorrent CLI to use this provider = {self.provider} # Display language [english, romaji] -# this is passed to anilist directly and is used to set the language which the anime titles will be in -# when using the anilist interface +# This is passed to Anilist directly and is used to set the language for anime titles +# when using the Anilist interface preferred_language = {self.preferred_language} # Download directory -# where you will find your videos after downloading them with 'fastanime download' command +# Where you will find your videos after downloading them with 'fastanime download' command downloads_dir = {self.downloads_dir} -# whether to show a preview window when using fzf or rofi [True/False] -# the preview requires you have a commandline image viewer as documented in the README -# this is only when using fzf or rofi -# if you dont care about image and text previews it doesnt matter -# though its awesome -# try it and you will see +# Whether to show a preview window when using fzf or rofi [True/False] +# The preview requires you to have a command-line image viewer as documented in the README +# This is only when using fzf or rofi +# If you don't care about image and text previews, it doesnโ€™t matter +# though itโ€™s awesome +# Try it, and you will see preview = {self.preview} -# whether to show images in the preview [true/false] -# windows users just swtich to linux ๐Ÿ˜„ -# cause even if you enable it +# Whether to show images in the preview [True/False] +# Windows users: just switch to Linux ๐Ÿ˜„ +# because even if you enable it # it won't look pretty -# just be satisfied with the text previews -# so forget it exists ๐Ÿคฃ +# Just be satisfied with the text previews +# So forget it exists ๐Ÿคฃ image_previews = {self.image_previews} # the time to seek when using ffmpegthumbnailer [-1 to 100] # -1 means random and is the default -# ffmpegthumbnailer is used to generate previews -# and you can select at what time in the video to extract an image -# random makes things quite exciting cause you never no at what time it will extract the image from -# used by the ```fastanime downloads``` command +# ffmpegthumbnailer is used to generate previews, +# allowing you to select the time in the video to extract an image. +# Random makes things quite exciting because you never know at what time it will extract the image. +# Used by the `fastanime downloads` command. ffmpegthumbnailer_seek_time = {self.ffmpegthumbnailer_seek_time} # specify the order of menu items in a comma-separated list. -# only include the base names of menu options (e.g., "Trending", "Recent"). -# default value is 'Trending,Recent,Watching,Paused,Dropped,Planned,Completed,Rewatching,Recently Updated Anime,Search,Watch History,Random Anime,Most Popular Anime,Most Favourite Anime,Most Scored Anime,Upcoming Anime,Edit Config,Exit' -# leave blank to use the default menu order. -# you can also omit some options by not including them in the list +# Only include the base names of menu options (e.g., "Trending", "Recent"). +# The default value is 'Trending,Recent,Watching,Paused,Dropped,Planned,Completed,Rewatching,Recently Updated Anime,Search,Watch History,Random Anime,Most Popular Anime,Most Favourite Anime,Most Scored Anime,Upcoming Anime,Edit Config,Exit'. +# Leave blank to use the default menu order. +# You can also omit some options by not including them in the list. menu_order = {self.menu_order} # whether to use fzf as the interface for the anilist command and others. [True/False] use_fzf = {self.use_fzf} -# whether to use rofi for the ui [True/False] -# it's more useful if you want to create a desktop entry -# which can be setup with 'fastanime config --desktop-entry' -# though if you want it to be your sole interface even when fastanime is run directly from the terminal +# whether to use rofi for the UI [True/False] +# It's more useful if you want to create a desktop entry, +# which can be set up with 'fastanime config --desktop-entry'. +# If you want it to be your sole interface even when fastanime is run directly from the terminal, enable this. use_rofi = {self.use_rofi} # rofi themes to use -# the values of this option is the path to the rofi config files to use -# i choose to split it into 4 since it gives the best look and feel -# you can refer to the rofi demo on github to see for your self -# i need help designing the default rofi themes -# if you fancy yourself a rofi ricer please contribute to making -# the default theme better +# The value of this option is the path to the rofi config files to use. +# I chose to split it into 4 since it gives the best look and feel. +# You can refer to the rofi demo on GitHub to see for yourself. +# I need help designing the default rofi themes. +# If you fancy yourself a rofi ricer, please contribute to improving +# the default theme. rofi_theme = {self.rofi_theme} rofi_theme_preview = {self.rofi_theme_preview} @@ -395,54 +395,51 @@ rofi_theme_input = {self.rofi_theme_input} rofi_theme_confirm = {self.rofi_theme_confirm} -# the duration in minutes a notification will stay in the screen -# used by notifier command +# the duration in minutes a notification will stay on the screen. +# Used by the notifier command. notification_duration = {self.notification_duration} -# used when the provider gives subs of different languages -# currently its the case for: -# hianime -# the values for this option are the short names for languages -# regex is used to determine what you selected +# used when the provider offers subtitles in different languages. +# Currently, this is the case for: +# hianime. +# The values for this option are the short names for languages. +# Regex is used to determine what you selected. sub_lang = {self.sub_lang} # what is your default media list tracking [track/disabled/prompt] -# only affects your anilist anime list -# track - means your progress will always be reflected in your anilist anime list -# disabled - means progress tracking will no longer be reflected in your anime list -# prompt - means for every anime you will be prompted whether you want your progress to be tracked or not +# This only affects your anilist anime list. +# track - means your progress will always be reflected in your anilist anime list. +# disabled - means progress tracking will no longer be reflected in your anime list. +# prompt - means you will be prompted for each anime whether you want your progress to be tracked or not. default_media_list_tracking = {self.default_media_list_tracking} -# whether media list tracking should only be updated when the next episode is greater than the previous -# this affects only your anilist anime list +# whether media list tracking should only be updated when the next episode is greater than the previous. +# This only affects your anilist anime list. force_forward_tracking = {self.force_forward_tracking} # whether to cache requests [true/false] -# this makes the experience better and more faster -# as data need not always be fetched from web server -# and instead can be gotten locally -# from the cached_requests_db +# This improves the experience by making it faster, +# as data doesn't always need to be fetched from the web server +# and can instead be retrieved locally from the cached_requests_db. cache_requests = {self.cache_requests} # the max lifetime for a cached request -# defaults to 3days = 03:00:00 -# this is the time after which a cached request will be deleted (technically : ) +# Defaults to 3 days = 03:00:00. +# This is the time after which a cached request will be deleted (technically). max_cache_lifetime = {self._max_cache_lifetime} -# whether to use a persistent store (basically a sqlitedb) for storing some data the provider requires -# to enable a seamless experience [true/false] -# this option exists primarily because i think it may help in the optimization -# of fastanime as a library in a website project -# for now i don't recommend changing it -# leave it as is +# whether to use a persistent store (basically an SQLite DB) for storing some data the provider requires +# to enable a seamless experience. [true/false] +# This option exists primarily to optimize FastAnime as a library in a website project. +# For now, it's not recommended to change it. Leave it as is. use_persistent_provider_store = {self.use_persistent_provider_store} -# no of recent anime to keep [0-50] -# 0 will disable recent anime tracking +# number of recent anime to keep [0-50]. +# 0 will disable recent anime tracking. recent = {self.recent} -# enable or disable discord activity updater -# if you want to enable it, please follow the lnik below to register the app with discord account +# enable or disable Discord activity updater. +# If you want to enable it, please follow the link below to register the app with your Discord account: # https://discord.com/oauth2/authorize?client_id=1292070065583165512 discord = {self.discord}