Changeset 6

Timestamp:

09/30/15 15:00:09 (9 years ago)

Author:

pinsard

Message:

describe requirements on ciclad for typo

Location:

trunk/docs/manual/source/developers/guides

Files:

• index.rst (modified) (1 diff)
• requirements.rst (added)
• typo.rst (modified) (5 diffs)

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

@@ -2 +2 @@
 |igcmg_doc| developers guides
 =============================
+
+|igcmg_doc| developers are |igcmg_doc| authors.
 
 .. toctree::

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

@@ +1 @@
+.. _typo:
+
 ====
 Typo
@@ -32 +34 @@
 +++++++++++++++++++++++++++
 
+.. note::
+
+   this work was done in PAGO project. not yet useful here
+
 :py:mod:`prog_var_francoise.py` is a way to build the dictionary "python
 variables".
-
-Assuming IGCMG_DOC is in :file:`$HOME/igcmg_doc_ws/` and
-:file:`$HOME/igcmg_doc_ws/docs/manual/` is
-in your :envvar:`PATH` or :envvar:`PYTHONPATH`
-
-Assuming :envvar:`PROJECT` is set to :file:`$HOME/igcmg_doc_ws/`.
-
-.. code-block:: bash
-
-   PROJECT=$HOME/igcmg_doc_ws/
-   export PROJECT
-   PYTHONPATH=$PROJECT/docs/manual/:$PYTHONPATH
-   export PYTHONPATH
-   PATH=$PROJECT/docs/manual/:$PATH
-   export PATH
-
-.. todo::
-
-   assuming and definition of :envvar:`PROJECT` is not only needed here
 
 .. code-block:: bash
@@ -89 +76 @@
    sort -u ${nontypo} > ${nontypo_uniq}
 
+.. note::
+
+   no ${PROJECT_LOG}/pyigcmg_doc_var.txt here
+
 Check typo in Python files
 ==========================
@@ -94 +85 @@
 .. code-block:: bash
 
-   PROJECT_LOG=${HOME}/log/ # as an example
-   export PROJECT_LOG
    listf=$(find ${PROJECT} -name "*.py")
    pylint --disable=all \
@@ -146 +135 @@
    sed "1i ${linecount}" ${nontypo_uniq} > ${nontypo_uniq_dic}
 
-.. warning:: sed vs gsed
-
-   On mac, :command:`sed` might have to be replaced by :command:`gsed`
-
 Associated :file:`nontypo_uniq.aff` file already exist in
 ${PROJECT}/docs/manual/for_typo: