pyGRASS docs: English fixes; ref vector attribute management; minor improvements

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@59951 15284696-431f-4ddb-bdfa-cd5b030d7da7

lib/python/pygrass/docs/attributes.rst

@@ -1,7 +1,7 @@
 Attributes
 ===========
 
-It is possible to access to the vector attributes with: ::
+It is possible to access the vector attributes with: ::
 
     >>> from pygrass.vector import Vector
     >>> municip = Vector('boundary_municp_sqlite')
@@ -135,4 +135,4 @@ Table
 -----
 
 .. autoclass:: pygrass.vector.table.Table
-    :members:
+    :members:

lib/python/pygrass/docs/conf.py

@@ -52,7 +52,7 @@ copyright = u'2012-2014, Pietro Zambelli'
 # The short X.Y version.
 version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = 'alpha'
+release = 'beta'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

lib/python/pygrass/docs/index.rst

@@ -3,19 +3,18 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to PyGrass's documentation!
+Welcome to PyGrass documentation!
 ===================================
 
-Since in the 2006 GRASS developers start to adopt python for the new GUI,
-python becoming more and more important and developers plan to convert all
-the bash scripts in to python for the next major release GRASS 7.
+In 2006, GRASS GIS developers started to adopt Python for the new GUI. Due
+to this Python became more and more important and developers converted all
+shell scripts from GRASS GIS 6 to Python for GRASS GIS 7.
 
-``pygrass`` want to improve integration between GRASS and python, make the
-use of python under GRASS more consistent with the language itself and make
-the GRASS scripting and programming activity easier and more natural
-to the final users.
+``pygrass`` improves the integration between GRASS GIS and Python, making
+the use of Python under GRASS more consistent with the language itself. Furthermore,
+it simplifies GRASS scripting and programming and more natural for the user.
 
-This project has been funded with support from the google Summer of Code 2012.
+This project has been funded with support from the Google Summer of Code 2012.
 
 
 Contents:

lib/python/pygrass/docs/intro.rst

@@ -1,30 +1,14 @@
 Introduction
 =============
 
-To work with ``pygrass`` you need a up-to-date version of GRASS 7.
-You can obtain a recent version following the information on the
-`main web site <http://grass.osgeo.org/download/software.php#g70x>`_
+To work with ``pygrass`` you need a up-to-date version of GRASS GIS 7.
+You can obtain a recent version following the information provided on the
+`main Web site <http://grass.osgeo.org/download/software/>`_
 of GRASS, and you can read more about compilation on the 
-`GRASS wiki <http://grass.osgeo.org/wiki/Compile_and_Install>`_
+`GRASS GIS Wiki <http://grasswiki.osgeo.org/wiki/Compile_and_Install>`_
 
-Now you can download the ``pygrass`` source using ``git``
+The only action before starting to work with ``pygrass`` is to launch 
+GRASS GIS 7 and from the console launch ``python`` or ``ipython`` 
+(the second one is the recommended way)
 
-::
-
-  git clone https://lucadeluge@code.google.com/p/pygrass/ 
-
-If you have not ``git`` you can install it from the `git website <http://git-scm.com/downloads>`_
-or download the source code of ``pygrass`` from `<http://code.google.com/p/pygrass/downloads/list>`_
-
-At this point you have to install ``pygrass``, so enter in the right 
-folder and launch with administration permission
-
-::
-
-  python setup.py install
-  
-The last action before start to work with ``pygrass`` is to run 
-GRASS 7 and from the console launch ``python`` or ``ipython`` 
-(the second one is the the suggested)
-
-Read more about how to work with :doc:`raster`, :doc:`vector`, :doc:`modules`.
+Read more about how to work with :doc:`raster`, :doc:`vector`, :doc:`attributes`, :doc:`modules`.

lib/python/pygrass/docs/modules.rst

@@ -61,7 +61,7 @@ Create the module object input step by step and run later: ::
 
 
 
-It is possible to access to the module info, with:
+It is possible to access the module info with:
 
     >>> slope_aspect.name
     'r.slope.aspect'

lib/python/pygrass/docs/raster.rst

@@ -3,16 +3,16 @@
 Raster
 ======
 
-PyGrass use 4 different Raster classes, that respect the 4 different approaches
-of C grass API.
+PyGRASS uses 4 different Raster classes, that respect the 4 different approaches
+of GRASS-C API.
 The read access is row wise for :ref:`RasterRow-label` and
 :ref:`RasterRowIO-label` and additionally
-cached in the RowIO class. Booth classes write sequentially.
+cached in the RowIO class. Both classes write sequentially.
 RowIO is row cached, :ref:`RasterSegment-label` and :ref:`RasterNumpy-label`
 are tile cached for reading and writing therefore a randomly access is possible.
 Hence RasterRow and RasterRowIO should be used in case for fast (cached)
 row read access and RasterRow for fast sequential writing.
-Segment and Numpy should be used for random access, but numpy only for files
+Segment and Numpy should be used for random access, but Numpy only for files
 not larger than 2GB.
 
 
@@ -110,7 +110,7 @@ See all the categories with: ::
      ('bare ground path', 10, None),
      ('grass', 11, None)]
 
-Access to single category, using Rast_get_ith_cat(), with: ::
+Access a single category, using Rast_get_ith_cat(), with: ::
 
     >>> land.cats[0]
     ('pond', 1, None)

lib/python/pygrass/pygrasslib.dox

@@ -4,13 +4,14 @@ by GRASS Development Team (http://grass.osgeo.org)
 
 \section pygrassIntro Introduction
 
-PyGRASS improves integration between GRASS and Python (see also \ref
-pythonlib), make the use of Python under GRASS more consistent with
-the language itself and make the GRASS scripting and programming
-activity easier and more natural to the final users.
+PyGRASS improves the integration between GRASS GIS and Python (see 
+also \ref pythonlib), making the use of Python under GRASS more 
+consistent with the language itself. Furthermore, it simplifies 
+GRASS scripting and programming and more natural for the user.
 
 \section pygrassPackages PyGRASS packages 
 
+The following PyGRASS packages are provided:
  - \subpage pygrassGis
  - \subpage pygrassRaster
  - \subpage pygrassVector
@@ -18,19 +19,21 @@ activity easier and more natural to the final users.
  - \subpage pygrassFunctions
  - \subpage pygrassMessages
  - \subpage pygrassErrors
+ 
+ Below these packages are illustrated in greater detail.
 
 \subsection pygrassGis GIS Package
 
  - python::pygrass::gis
 
-Basic elements of GRASS data-base:
+Basic elements of the GRASS data-base:
 
   - python::pygrass::gis::Gisdbase
   - python::pygrass::gis::Location
   - python::pygrass::gis::Mapset
   - python::pygrass::gis::VisibleMapset
 
-Computation region:
+Computational region:
 
   - python::pygrass::gis::region::Region
 
@@ -41,6 +44,16 @@ Mapset handling:
 
 \subsection pygrassRaster Raster Package
 
+PyGRASS uses 4 different Raster classes, that respect the 4 
+different approaches of GRASS-C API. The read access is row wise for 
+RastRow and RasterRowIO and additionally cached in the RowIO class. 
+Both classes write sequentially. RowIO is row cached, RastSegment 
+and RasterNumpy are tile cached for reading and writing therefore a 
+randomly access is possible. Hence RasterRow and RasterRowIO should 
+be used in case for fast (cached) row read access and RasterRow for 
+fast sequential writing. Segment and Numpy should be used for random 
+access, but Numpy only for files not larger than 2GB.
+
  - python::pygrass::raster
 
 Reading/writing raster maps:
@@ -101,7 +114,11 @@ Geometry and topology elements handling:
   - python::pygrass::vector::geometry::Isles
   - python::pygrass::vector::geometry::Area
 
-\subsection pygrassModule Interface to GRASS modules
+Vector attribute handling:
+
+ - python::pygrass::vector::attributes
+
+\subsection pygrassModule Interface to GRASS GIS modules
 
  - python::pygrass::modules