From c0ca18a67b398ec2fe8280570fe0de8eded4f0ff Mon Sep 17 00:00:00 2001 From: Denis Seleznev Date: Sun, 12 Nov 2023 20:44:31 +0300 Subject: [PATCH] Update docs --- README.md | 17 ----------------- README.ru.md | 16 ---------------- 2 files changed, 33 deletions(-) diff --git a/README.md b/README.md index 4f0ad99..ed8808f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,6 @@ Add this to your `.pre-commit-config.yaml`: - id: yaspeller ``` - ### Examples + `yaspeller README.md` — search typos in the file. + `yaspeller "*.md"` — node glob syntax for Windows. @@ -95,16 +94,9 @@ Example: `console,html,custom_report.js` #### `--check-yo` Check the correctness of using the letter “Ё” (Yo) in Russian texts. -#### `--by-words` -Do not use a dictionary environment (context) during the scan.
-This is useful in cases where the service is transmitted to the input of a list of individual words. - #### `--find-repeat-words` Highlight repetitions of words, consecutive. For example, `I flew to to to Cyprus`. -#### `--flag-latin` -Flag words, written in Latin, as erroneous. - #### `--ignore-tags ` Ignore HTML tags.
Default: `code,kbd,object,samp,script,style,var`
@@ -119,15 +111,6 @@ Ignore the incorrect use of UPPERCASE / lowercase letters, for example, in the w #### `--ignore-digits` Ignore words with numbers, such as `avp17h4534`. -#### `--ignore-latin` -Ignore words, written in Latin, for example, `madrid`. - -#### `--ignore-roman-numerals` -Ignore Roman numerals `I, II, III, ...`. - -#### `--ignore-uppercase` -Ignore words written in capital letters. - #### `--ignore-urls` Ignore Internet addresses, email addresses and filenames. diff --git a/README.ru.md b/README.ru.md index c6af452..75eddd7 100644 --- a/README.ru.md +++ b/README.ru.md @@ -87,16 +87,9 @@ JSON-файл собственного словаря. #### `--check-yo` Проверять корректность использования буквы «ё» в русских текстах. -#### `--by-words` -Не использовать словарное окружение (контекст) при проверке.
-Опция полезна в случаях, когда на вход сервиса передаётся список отдельных слов. - #### `--find-repeat-words` Находить повторы слов, идущие подряд. Например, `я полетел на на Кипр`. -#### `--flag-latin` -Отмечать слова, написанные латиницей, как ошибочные. - #### `--ignore-tags ` Игнорировать HTML-теги.
По умолчанию: `code,kbd,object,samp,script,style,var`
@@ -111,15 +104,6 @@ JSON-файл собственного словаря. #### `--ignore-digits` Пропускать слова с цифрами, например, `авп17х4534`. -#### `--ignore-latin` -Пропускать слова, написанные латиницей, например, `madrid`. - -#### `--ignore-roman-numerals` -Игнорировать римские цифры `I, II, III, ...`. - -#### `--ignore-uppercase` -Пропускать слова, написанные заглавными буквами, например, `ВПК`. - #### `--ignore-urls` Пропускать интернет-адреса, почтовые адреса и имена файлов.