Changeset 3 for trunk/docs/manual/source/developers/guides

Timestamp:

09/25/15 19:00:49 (9 years ago)

Author:

pinsard

Message:

add some supplemental dictionaries

File:

• trunk/docs/manual/source/developers/guides/typo.rst (modified) (5 diffs)

trunk/docs/manual/source/developers/guides/typo.rst

@@ -68 +68 @@
 dictionaries used in an spelling check of all :file:`*.py` via :command:`pylint`.
 
-This supplemental dictionary will also be the base of the one used by
-:command:`hunspell`.
+They also will be the base of the one used by :command:`hunspell`.
+
+They must be encoded in UTF-8.
 
 .. code-block:: bash
@@ -82 +83 @@
    done
    cat ${PROJECT_LOG}/pyigcmg_doc_var.txt >> ${nontypo}
-   sort -u ${nontypo} > ${nontypo_uniq}
+   sort --ignore-case -u ${nontypo} > ${nontypo_uniq}
 
 Check typo in Python files
@@ -98 +99 @@
    --reports=n \
    ${listf} | grep "Wrong spelling" | awk -F: '{print $3}' | \
-   sort -u > ${PROJECT_LOG}/typo
+   sort --ignore-case -u > ${PROJECT_LOG}/typo
 
 .. todo::
@@ -166 +167 @@
       hunspell -d en_US,nontypo_uniq --check-url -i utf-8 -l < ${onefile} >> ${hunspell_out}
    done
-   sort -u ${hunspell_out} > ${hunspell_uniq_out}
+   sort --ignore-case -u ${hunspell_out} > ${hunspell_uniq_out}
 
 .. todo::
@@ -223 +224 @@
       hunspell -d en_US,nontypo_uniq --check-url -i utf-8 -l < ${onefile} >> ${hunspell_out}
    done
-   sort -u ${hunspell_out} > ${hunspell_uniq_out}
-
-Correction have to be done via the wiki interface of the forge.
+   sort --ignore-case -u ${hunspell_out} > ${hunspell_uniq_out}
+
+To find one of the wrong spelling in downloaded HTML pages:
+
+.. code-block:: bash
+
+   w=amonch
+   find ${dirhtml} -name "Doc*" -exec grep -Hi ${w} {} \;
+
+.. warning:
+
+   Correction have to be done via the wiki interface of the forge.