From dcc74fba426fcbd71406fe2d7b12b8bc75363cb2 Mon Sep 17 00:00:00 2001 From: mikeqfu Date: Sat, 17 Jun 2023 19:58:02 +0100 Subject: [PATCH] Update docs\source\ --- docs/source/conf.py | 6 ++++-- docs/source/quick-start.rst | 11 +++++------ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 88f6fb0..1adf10a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -243,7 +243,7 @@ def __init__(self, **options): \clearpage \pagenumbering{arabic} - ''' % (project, + ''' % (__project__, __description__.rstrip('.'), release, __author__, @@ -269,6 +269,8 @@ def __init__(self, **options): \linespread{1.05} \renewcommand{\sfdefault}{pplj} \newunicodechar{≤}{\ensuremath{\leq}} + \newunicodechar{≈}{\ensuremath{\approx}} + \newunicodechar{≥}{\ensuremath{\geq}} \IfFileExists{zlmtt.sty} {\usepackage[light,scaled=1.05]{zlmtt}} {\renewcommand{\ttdefault}{lmtt}} @@ -294,7 +296,7 @@ def __init__(self, **options): 'preamble': latex_preamble, - 'figure_align': 'H', # 'htbp', + 'figure_align': 'H', # Latex figure (float) alignment; optional: 'htbp' 'extraclassoptions': 'openany,oneside', 'maketitle': latex_maketitle, diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst index 1557d34..9202144 100644 --- a/docs/source/quick-start.rst +++ b/docs/source/quick-start.rst @@ -531,22 +531,21 @@ The module :mod:`pyhelpers.text` can assist us in manipulating textual data. For >>> result_1 'Anglia' -By default, the function relies on `difflib`_ - a Python built-in module - to perform the task. Alternatively, we could also make use of an open-source package, `FuzzyWuzzy`_, via setting the parameter ``engine='fuzzywuzzy'``: +By default, the function relies on `difflib`_ - a Python built-in module - to perform the task. Alternatively, we could also make use of an open-source package, `RapidFuzz`_, via setting the parameter ``engine='rapidfuzz'`` (or simply ``engine='fuzz'``): -.. _`FuzzyWuzzy`: https://pypi.org/project/fuzzywuzzy/ .. _`difflib`: https://docs.python.org/3/library/difflib.html +.. _`RapidFuzz`: https://pypi.org/project/rapidfuzz/ .. code-block:: python - >>> # Find the most similar word to 'angle' by using FuzzyWuzzy - >>> result_2 = find_similar_str(word, lookup_list, engine='fuzzywuzzy') + >>> # Find the most similar word to 'angle' by using RapidFuzz + >>> result_2 = find_similar_str(word, lookup_list, engine='rapidfuzz') >>> result_2 'Anglia' .. note:: - - The package `FuzzyWuzzy`_ is NOT an essential dependency for the installation of pyhelpers>=1.3.0. We need to install it (e.g. via ``pip install``) to make the function run successfully with setting ``engine='fuzzywuzzy'``. - - In previous versions of pyhelpers (i.e. pyhelpers<=1.2.14), optional values for the parameter ``engine`` include ``'fuzzywuzzy'`` and ``'nltk'``. The latter has been replaced with ``'difflib'`` since pyhelpers 1.2.15. + - The package `RapidFuzz`_ is NOT an essential dependency for the installation of pyhelpers. We need to install it (e.g. via ``pip install``) to make the function run successfully with setting ``engine='rapidfuzz'`` (or ``engine='fuzz'``).