From a5f073fea845830f24c0093cf764aa693872b452 Mon Sep 17 00:00:00 2001 From: BLKSerene Date: Fri, 17 Jan 2025 22:52:25 +0800 Subject: [PATCH 1/4] Standardize the capitalization of Pyphen in doc --- README.rst | 4 ++-- docs/common_use_cases.rst | 2 +- docs/contribute.rst | 8 ++++---- docs/first_steps.rst | 4 ++-- docs/going_further.rst | 8 ++++---- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index e565414..3f9417e 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ hyphenation dictionaries. This module is a fork of python-hyphenator, written by Wilbert Berendsen. -Many dictionaries are included in pyphen, they come from the LibreOffice git +Many dictionaries are included in Pyphen, they come from the LibreOffice git repository and are distributed under GPL, LGPL and/or MPL. Dictionaries are not modified in this repository. See the dictionaries and LibreOffice's repository for more details. @@ -26,5 +26,5 @@ CourtBouillon (https://www.courtbouillon.org). Copyrights are retained by their contributors, no copyright assignment is required to contribute to Pyphen. Unless explicitly stated otherwise, any contribution intentionally submitted for inclusion is licensed under -GPL 2.0+/LGPL 2.1+/MPL 1.1, without any additional terms or conditions. For +GPL 2.0+/LGPL 2.1+/MPL 1.1, without any additional terms or conditions. For full authorship information, see the version control history. diff --git a/docs/common_use_cases.rst b/docs/common_use_cases.rst index c6d3101..03ee509 100644 --- a/docs/common_use_cases.rst +++ b/docs/common_use_cases.rst @@ -1,7 +1,7 @@ Common Use Cases ================ -pyphen has been created for WeasyPrint and many common use cases can thus be +Pyphen has been created for WeasyPrint and many common use cases can thus be found in `its repository`_. .. _its repository: https://github.com/Kozea/WeasyPrint diff --git a/docs/contribute.rst b/docs/contribute.rst index 7f538cb..c4dde67 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -1,12 +1,12 @@ Contribute ========== -You want to add some code to pyphen, launch its tests or improve its +You want to add some code to Pyphen, launch its tests or improve its documentation? Thank you very much! Here are some tips to help you play with -pyphen in good conditions. +Pyphen in good conditions. The first step is to clone the repository, create a virtual environment and -install pyphen dependencies. +install Pyphen dependencies. .. code-block:: shell @@ -25,7 +25,7 @@ You can then launch Python to test your changes. Code & Issues ------------- -If you’ve found a bug in pyphen, it’s time to report it, and to fix it if you +If you’ve found a bug in Pyphen, it’s time to report it, and to fix it if you can! You can report bugs and feature requests on GitHub_. If you want to add or diff --git a/docs/first_steps.rst b/docs/first_steps.rst index 9c064bc..7f3bba8 100644 --- a/docs/first_steps.rst +++ b/docs/first_steps.rst @@ -5,9 +5,9 @@ First Steps Installation ------------ -The easiest way to use pyphen is to install it in a Python `virtual +The easiest way to use Pyphen is to install it in a Python `virtual environment`_. When your virtual environment is activated, you can then install -pyphen with pip_:: +Pyphen with pip_:: pip install pyphen diff --git a/docs/going_further.rst b/docs/going_further.rst index 3d184ed..d62e3db 100644 --- a/docs/going_further.rst +++ b/docs/going_further.rst @@ -2,14 +2,14 @@ Going Further ============= -Why pyphen? +Why Pyphen? ----------- -pyphen has been created to handle hyphenation in WeasyPrint_. +Pyphen has been created to handle hyphenation in WeasyPrint_. We wanted to provide a simple Python API and to include hyphenation dictionaries. So we forked the discontinued python-hyphenator module, written -by Wilbert Berendsen, and released pyphen. +by Wilbert Berendsen, and released Pyphen. .. _WeasyPrint: https://www.courtbouillon.org/weasyprint @@ -23,6 +23,6 @@ high-level classes and a small amount of very simple code. And of course, WeasyPrint is written in Python too, giving an obvious reason for this choice. -Speed is not pyphen’s main goal. Code simplicity, maintainability and +Speed is not Pyphen’s main goal. Code simplicity, maintainability and flexibility are more important goals for this library, as they give the ability to stay really close to the specification and to fix bugs easily. From 4e40d46f08b5b411a05db882850dc3f5d585692c Mon Sep 17 00:00:00 2001 From: BLKSerene Date: Fri, 17 Jan 2025 22:52:43 +0800 Subject: [PATCH 2/4] Fix a typo in doc --- docs/support.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/support.rst b/docs/support.rst index 120158c..be7145e 100644 --- a/docs/support.rst +++ b/docs/support.rst @@ -12,7 +12,7 @@ add new features, fix bugs, and improve documentation. .. _donations and sponsorship: https://opencollective.com/courtbouillon -Professionnal Support +Professional Support --------------------- You can improve your experience with CourtBouillon’s tools thanks to our From 38d7d020cc165efccccbbe98ec294a2a659c0fab Mon Sep 17 00:00:00 2001 From: BLKSerene Date: Fri, 17 Jan 2025 23:03:48 +0800 Subject: [PATCH 3/4] Update the list of included dictionaries in doc --- docs/first_steps.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/first_steps.rst b/docs/first_steps.rst index 7f3bba8..78ecc4e 100644 --- a/docs/first_steps.rst +++ b/docs/first_steps.rst @@ -32,6 +32,8 @@ The dictionaries included in LibreOffice are distributed with Pyphen: * Afrikaans * Albanian +* Assamese +* Basque * Belarusian * Bulgarian * Catalan @@ -39,7 +41,7 @@ The dictionaries included in LibreOffice are distributed with Pyphen: * Czech * Danish * Dutch -* English (Great-Britain and United-States) +* English (United Kingdom and United States) * Esperanto * Estonian * French @@ -50,15 +52,20 @@ The dictionaries included in LibreOffice are distributed with Pyphen: * Icelandic * Indonesian * Italian +* Kannada * Lithuanian * Latvian +* Marathi * Mongolian * Norwegian (Bokmål and Nynorsk) +* Oriya * Polish * Portuguese (Brazil and Portugal) +* Punjabi * Romanian * Russian -* Serbian (cyrillic and latin) +* Sanskrit +* Serbian (Cyrillic and Latin) * Slovak * Slovenian * Spanish From 7a4e237d972936cbd90f9c01fd206412ecc37d03 Mon Sep 17 00:00:00 2001 From: BLKSerene Date: Fri, 17 Jan 2025 23:15:22 +0800 Subject: [PATCH 4/4] Fix file name of the Oriya dictionary --- pyphen/dictionaries/{hypn_or_IN.dic => hyph_or_IN.dic} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pyphen/dictionaries/{hypn_or_IN.dic => hyph_or_IN.dic} (100%) diff --git a/pyphen/dictionaries/hypn_or_IN.dic b/pyphen/dictionaries/hyph_or_IN.dic similarity index 100% rename from pyphen/dictionaries/hypn_or_IN.dic rename to pyphen/dictionaries/hyph_or_IN.dic