diff options
| author | Mike Taves <mwtoews@gmail.com> | 2021-05-04 09:05:06 +1200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-04 09:05:06 +1200 |
| commit | ea3f53746c859c73c775bf11d17f8471d0fb59f2 (patch) | |
| tree | 53e3ea1cf0a5f22786f0b7805bc638e41151500b /docs/source/development | |
| parent | 371bc3c5e7472d4f2fdffad0b39e7c9d27abf234 (diff) | |
| download | PROJ-ea3f53746c859c73c775bf11d17f8471d0fb59f2.tar.gz PROJ-ea3f53746c859c73c775bf11d17f8471d0fb59f2.zip | |
DOC: configure and add spelling wordlist; fix typos, apply Sphinx syntax (#2705)
Diffstat (limited to 'docs/source/development')
| -rw-r--r-- | docs/source/development/index.rst | 4 | ||||
| -rw-r--r-- | docs/source/development/migration.rst | 81 | ||||
| -rw-r--r-- | docs/source/development/quickstart.rst | 9 | ||||
| -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 |
6 files changed, 65 insertions, 64 deletions
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 <https://github.com/OSGeo/proj-datu .. attention:: - The ``projects.h`` header and the functions related to it is considered + The :file:`projects.h` header and the functions related to it is considered deprecated from version 5.0.0 and onwards. The header has been removed PROJ in version 6.0.0 released February 1st 2019. @@ -38,7 +38,7 @@ are maintained in a `separate git repository <https://github.com/OSGeo/proj-datu .. attention:: - The ``proj_api.h`` header and the functions related to it is + The :file:`proj_api.h` header and the functions related to it is considered deprecated from version 5.0.0 and onwards. The header has been removed in version 8.0.0 released March 1st 2021. diff --git a/docs/source/development/migration.rst b/docs/source/development/migration.rst index 29c56b4b..4c0113e5 100644 --- a/docs/source/development/migration.rst +++ b/docs/source/development/migration.rst @@ -109,58 +109,58 @@ Function mapping from old to new API +---------------------------------------+-------------------------------------------------+ | Old API functions | New API functions | +=======================================+=================================================+ -| pj_fwd | :c:func:`proj_trans` | +| ``pj_fwd`` | :c:func:`proj_trans` | +---------------------------------------+-------------------------------------------------+ -| pj_inv | :c:func:`proj_trans` | +| ``pj_inv`` | :c:func:`proj_trans` | +---------------------------------------+-------------------------------------------------+ -| pj_fwd3 | :c:func:`proj_trans` | +| ``pj_fwd3`` | :c:func:`proj_trans` | +---------------------------------------+-------------------------------------------------+ -| pj_inv3 | :c:func:`proj_trans` | +| ``pj_inv3`` | :c:func:`proj_trans` | +---------------------------------------+-------------------------------------------------+ -| pj_transform | :c:func:`proj_create_crs_to_crs` | +| ``pj_transform`` | :c:func:`proj_create_crs_to_crs` | | | or :c:func:`proj_create_crs_to_crs_from_pj` + | | | (:c:func:`proj_normalize_for_visualization` +) | | | :c:func:`proj_trans`, | | | :c:func:`proj_trans_array` or | | | :c:func:`proj_trans_generic` | +---------------------------------------+-------------------------------------------------+ -| pj_init | :c:func:`proj_create` / | +| ``pj_init`` | :c:func:`proj_create` / | | | :c:func:`proj_create_crs_to_crs` | +---------------------------------------+-------------------------------------------------+ -| pj_init | :c:func:`proj_create` / | +| ``pj_init`` | :c:func:`proj_create` / | | | :c:func:`proj_create_crs_to_crs` | +---------------------------------------+-------------------------------------------------+ -| pj_free | :c:func:`proj_destroy` | +| ``pj_free`` | :c:func:`proj_destroy` | +---------------------------------------+-------------------------------------------------+ -| pj_is_latlong | :c:func:`proj_get_type` | +| ``pj_is_latlong`` | :c:func:`proj_get_type` | +---------------------------------------+-------------------------------------------------+ -| pj_is_geocent | :c:func:`proj_get_type` | +| ``pj_is_geocent`` | :c:func:`proj_get_type` | +---------------------------------------+-------------------------------------------------+ -| pj_get_def | :c:func:`proj_pj_info` | +| ``pj_get_def`` | :c:func:`proj_pj_info` | +---------------------------------------+-------------------------------------------------+ -| pj_latlong_from_proj | *No direct equivalent*, but can be accomplished | +| ``pj_latlong_from_proj`` | *No direct equivalent*, but can be accomplished | | | by chaining :c:func:`proj_create`, | | | :c:func:`proj_crs_get_horizontal_datum` and | | | :c:func:`proj_create_geographic_crs_from_datum` | +---------------------------------------+-------------------------------------------------+ -| pj_set_finder | :c:func:`proj_context_set_file_finder` | +| ``pj_set_finder`` | :c:func:`proj_context_set_file_finder` | +---------------------------------------+-------------------------------------------------+ -| pj_set_searchpath | :c:func:`proj_context_set_search_paths` | +| ``pj_set_searchpath`` | :c:func:`proj_context_set_search_paths` | +---------------------------------------+-------------------------------------------------+ -| pj_deallocate_grids | *No equivalent* | +| ``pj_deallocate_grids`` | *No equivalent* | +---------------------------------------+-------------------------------------------------+ -| pj_strerrno | *No equivalent* | +| ``pj_strerrno`` | *No equivalent* | +---------------------------------------+-------------------------------------------------+ -| pj_get_errno_ref | :c:func:`proj_errno` | +| ``pj_get_errno_ref`` | :c:func:`proj_errno` | +---------------------------------------+-------------------------------------------------+ -| pj_get_release | :c:func:`proj_info` | +| ``pj_get_release`` | :c:func:`proj_info` | +---------------------------------------+-------------------------------------------------+ Backward incompatibilities ############################################################################### -Access to the proj_api.h is still possible but requires to define the +Access to the :file:`proj_api.h` is still possible but requires to define the ``ACCEPT_USE_OF_DEPRECATED_PROJ_API_H`` macro. The emulation of the now deprecated ``+init=epsg:XXXX`` syntax in PROJ 6 is not @@ -234,9 +234,9 @@ how to use it. First note that in order to go from system A to system B, the old starts by doing an **inverse** transformation from system A to WGS84, then does a **forward** transformation from WGS84 to system B. -With ``cs2cs`` being the command line interface to the old API, and ``cct`` being the same -for the new, this example of doing the same thing in both world views will should give -an idea of the differences: +With :program:`cs2cs` being the command line interface to the old API, and +:program:`cct` being the same for the new, this example of doing the same +thing in both world views will should give an idea of the differences: :: @@ -348,39 +348,40 @@ Function mapping from old to new API +---------------------------------------+---------------------------------------+ | Old API functions | New API functions | +=======================================+=======================================+ -| pj_fwd | :c:func:`proj_trans` | +| ``pj_fwd`` | :c:func:`proj_trans` | +---------------------------------------+---------------------------------------+ -| pj_inv | :c:func:`proj_trans` | +| ``pj_inv`` | :c:func:`proj_trans` | +---------------------------------------+---------------------------------------+ -| pj_fwd3 | :c:func:`proj_trans` | +| ``pj_fwd3`` | :c:func:`proj_trans` | +---------------------------------------+---------------------------------------+ -| pj_inv3 | :c:func:`proj_trans` | +| ``pj_inv3`` | :c:func:`proj_trans` | +---------------------------------------+---------------------------------------+ -| pj_transform | proj_trans_array or proj_trans_generic| +| ``pj_transform`` | :c:func:`proj_trans_array` or | +| | :c:func:`proj_trans_generic` | +---------------------------------------+---------------------------------------+ -| pj_init | :c:func:`proj_create` | +| ``pj_init`` | :c:func:`proj_create` | +---------------------------------------+---------------------------------------+ -| pj_init_plus | :c:func:`proj_create` | +| ``pj_init_plus`` | :c:func:`proj_create` | +---------------------------------------+---------------------------------------+ -| pj_free | :c:func:`proj_destroy` | +| ``pj_free`` | :c:func:`proj_destroy` | +---------------------------------------+---------------------------------------+ -| pj_is_latlong | :c:func:`proj_angular_output` | +| ``pj_is_latlong`` | :c:func:`proj_angular_output` | +---------------------------------------+---------------------------------------+ -| pj_is_geocent | :c:func:`proj_angular_output` | +| ``pj_is_geocent`` | :c:func:`proj_angular_output` | +---------------------------------------+---------------------------------------+ -| pj_get_def | :c:func:`proj_pj_info` | +| ``pj_get_def`` | :c:func:`proj_pj_info` | +---------------------------------------+---------------------------------------+ -| pj_latlong_from_proj | *No equivalent* | +| ``pj_latlong_from_proj`` | *No equivalent* | +---------------------------------------+---------------------------------------+ -| pj_set_finder | *No equivalent* | +| ``pj_set_finder`` | *No equivalent* | +---------------------------------------+---------------------------------------+ -| pj_set_searchpath | *No equivalent* | +| ``pj_set_searchpath`` | *No equivalent* | +---------------------------------------+---------------------------------------+ -| pj_deallocate_grids | *No equivalent* | +| ``pj_deallocate_grids`` | *No equivalent* | +---------------------------------------+---------------------------------------+ -| pj_strerrno | *No equivalent* | +| ``pj_strerrno`` | *No equivalent* | +---------------------------------------+---------------------------------------+ -| pj_get_errno_ref | :c:func:`proj_errno` | +| ``pj_get_errno_ref`` | :c:func:`proj_errno` | +---------------------------------------+---------------------------------------+ -| pj_get_release | :c:func:`proj_info` | +| ``pj_get_release`` | :c:func:`proj_info` | +---------------------------------------+---------------------------------------+ diff --git a/docs/source/development/quickstart.rst b/docs/source/development/quickstart.rst index d53d98fd..eefd5ac3 100644 --- a/docs/source/development/quickstart.rst +++ b/docs/source/development/quickstart.rst @@ -12,8 +12,8 @@ be seen at the end of the section. See the following sections for more in-depth descriptions of different parts of the PROJ API or consult the :doc:`API reference <reference/index>` 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 <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) |
