diff options
Diffstat (limited to 'docs/source/development/reference')
| -rw-r--r-- | docs/source/development/reference/datatypes.rst | 23 | ||||
| -rw-r--r-- | docs/source/development/reference/functions.rst | 6 | ||||
| -rw-r--r-- | docs/source/development/reference/macros.rst | 6 |
3 files changed, 18 insertions, 17 deletions
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 <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) |