From ea3f53746c859c73c775bf11d17f8471d0fb59f2 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Tue, 4 May 2021 09:05:06 +1200 Subject: DOC: configure and add spelling wordlist; fix typos, apply Sphinx syntax (#2705) --- docs/source/development/index.rst | 4 +- docs/source/development/migration.rst | 81 +++++++++++++------------ docs/source/development/quickstart.rst | 9 ++- docs/source/development/reference/datatypes.rst | 23 +++---- docs/source/development/reference/functions.rst | 6 +- docs/source/development/reference/macros.rst | 6 +- 6 files changed, 65 insertions(+), 64 deletions(-) (limited to 'docs/source/development') diff --git a/docs/source/development/index.rst b/docs/source/development/index.rst index f985279f..2d544189 100644 --- a/docs/source/development/index.rst +++ b/docs/source/development/index.rst @@ -27,7 +27,7 @@ are maintained in a `separate git repository ` for specifics. -Before the PROJ API can be used it is necessary to include the ``proj.h`` header -file. Here ``stdio.h`` is also included so we can print some text to the screen: +Before the PROJ API can be used it is necessary to include the :file:`proj.h` header +file. Here :file:`stdio.h` is also included so we can print some text to the screen: .. literalinclude:: ../../../examples/pj_obs_api_mini_demo.c :language: c @@ -45,7 +45,7 @@ a string that describes the target CRS and an optional description of the area o use. The strings for the source or target CRS may be PROJ strings (``+proj=longlat +datum=WGS84``), CRS identified by their code (``EPSG:4326`` or ``urn:ogc:def:crs:EPSG::4326``) or -by a well-known text (WKT) string ( +by a well-known text (WKT) string: :: GEOGCRS["WGS 84", @@ -67,7 +67,6 @@ by a well-known text (WKT) string ( BBOX[-90,-180,90,180]], ID["EPSG",4326]] -). The use of PROJ strings to describe a CRS is considered as legacy (one of the main weakness of PROJ strings is their inability to describe a geodetic datum, other than the few ones hardcoded in the ``+datum`` parameter). @@ -115,7 +114,7 @@ projected CRS. PROJ uses its own data structures for handling coordinates. Here we use a :c:type:`PJ_COORD` which is easily assigned with the function :c:func:`proj_coord`. -When using +proj=longlat, the order of coordinates is longitude, latitude, +When using ``+proj=longlat``, the order of coordinates is longitude, latitude, and values are expressed in degrees. If you used instead a EPSG geographic CRS, like EPSG:4326 (WGS84), it would be latitude, longitude. diff --git a/docs/source/development/reference/datatypes.rst b/docs/source/development/reference/datatypes.rst index b4d3f5c1..e7b5cca0 100644 --- a/docs/source/development/reference/datatypes.rst +++ b/docs/source/development/reference/datatypes.rst @@ -571,7 +571,7 @@ List structures .. c:member:: const char *ell - Elliptical parameter, e.g. `rf=298.257` or `b=6356772.2`. + Elliptical parameter, e.g. ``rf=298.257`` or ``b=6356772.2``. .. c:member:: const char *name @@ -670,8 +670,9 @@ Info structures Search path for PROJ. List of directories separated by semicolons (Windows) or colons (non-Windows), e.g. - "C:\\Users\\doctorwho;C:\\OSGeo4W64\\share\\proj". - Grids and init files are looked for in directories in the search path. + ``C:\\Users\\doctorwho;C:\\OSGeo4W64\\share\\proj``. + Grids and :ref:`init files ` are looked for in + directories in the search path. .. c:type:: PJ_PROJ_INFO @@ -694,7 +695,7 @@ Info structures .. c:member:: const char *PJ_PROJ_INFO.id Short ID of the operation the :c:type:`PJ` object is based on, that is, - what comes afther the ``+proj=`` in a proj-string, e.g. "*merc*". + what comes after the ``+proj=`` in a proj-string, e.g. "*merc*". .. c:member:: const char *PJ_PROJ_INFO.description @@ -757,7 +758,7 @@ Info structures .. c:member:: int PJ_GRID_INFO.n_lat - Number of grid cells in the latitudianl direction. + Number of grid cells in the latitudinal direction. .. c:member:: double PJ_GRID_INFO.cs_lon @@ -793,7 +794,7 @@ Info structures .. c:member:: char PJ_INIT_INFO.version[32] - Version number of init-file, e.g. "*9.0.0*" + Version number of init file, e.g. "*9.0.0*" .. c:member:: char PJ_INIT_INFO.origin[32] @@ -801,7 +802,7 @@ Info structures .. c:member:: char PJ_INIT_INFO.lastupdate - Date of last update of the init-file. + Date of last update of the init file. .. _error_codes: @@ -860,16 +861,16 @@ Errors in class PROJ_ERR_COORD_TRANSFM .. c:macro:: PROJ_ERR_COORD_TRANSFM_INVALID_COORD - Invalid input coordinate. e.g a latitude > 90°. + Invalid input coordinate. e.g. a latitude > 90°. .. c:macro:: PROJ_ERR_COORD_TRANSFM_OUTSIDE_PROJECTION_DOMAIN - Coordinate is outside of the projection domain. e.g approximate mercator with \|longitude - lon_0\| > 90°, - or iterative convergence method failed. + Coordinate is outside of the projection domain. e.g. approximate mercator + with \|longitude - lon_0\| > 90°, or iterative convergence method failed. .. c:macro:: PROJ_ERR_COORD_TRANSFM_NO_OPERATION - No operation found, e.g if no match the required accuracy, or if ballpark transformations + No operation found, e.g. if no match the required accuracy, or if ballpark transformations were asked to not be used and they would be only such candidate. .. c:macro:: PROJ_ERR_COORD_TRANSFM_OUTSIDE_GRID diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index edb61b08..29b52149 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -33,7 +33,7 @@ Transformation setup ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The objects returned by the functions defined in this section have minimal -interaction with the the functions of the +interaction with the functions of the `C API for ISO-19111 functionality`_, and vice versa. See its introduction paragraph for more details. @@ -686,7 +686,7 @@ Distances :param PJ_COORD b: Coordinate of second point :returns: `PJ_COORD` where the first value is the distance between :c:data:`a` and :c:data:`b` in meters, the second value is the forward azimuth - and the thir value is the reverse azimuth. The fourth coordinate + and the third value is the reverse azimuth. The fourth coordinate value is unused. @@ -930,7 +930,7 @@ The PJ* objects returned by :c:func:`proj_create_from_wkt`, :c:func:`proj_create_from_database` and other functions in that section will have generally minimal interaction with the functions declared in the previous sections (calling those functions on those objects -will either return an error or default/non-sensical values). The exception is +will either return an error or default/nonsensical values). The exception is for ISO19111 objects of type CoordinateOperation that can be exported as a valid PROJ pipeline. In this case, objects will work for example with :c:func:`proj_trans_generic`. diff --git a/docs/source/development/reference/macros.rst b/docs/source/development/reference/macros.rst index 131b8e72..c25aeed2 100644 --- a/docs/source/development/reference/macros.rst +++ b/docs/source/development/reference/macros.rst @@ -6,15 +6,15 @@ Macros .. c:macro:: PROJ_VERSION_MAJOR - Major version number, e.g 8 for PROJ 8.0.1 + Major version number, e.g. 8 for PROJ 8.0.1 .. c:macro:: PROJ_VERSION_MINOR - Minor version number, e.g 0 for PROJ 8.0.1 + Minor version number, e.g. 0 for PROJ 8.0.1 .. c:macro:: PROJ_VERSION_PATCH - Patch version number, e.g 1 for PROJ 8.0.1 + Patch version number, e.g. 1 for PROJ 8.0.1 .. c:macro:: PROJ_COMPUTE_VERSION(maj,min,patch) -- cgit v1.2.3