Doc Reference enhancements #380
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move admin sections to bottom Signed-off-by: Martin Davis <mtnclimb@gmail.com>
Add abstract Signed-off-by: Martin Davis <mtnclimb@gmail.com>
Improve data type section Signed-off-by: Martin Davis <mtnclimb@gmail.com>
Signed-off-by: Martin Davis <mtnclimb@gmail.com>
Komzpa
reviewed
Mar 11, 2019
doc/reference_guc.xml
Outdated
| @@ -2,10 +2,11 @@ | |||
| <sect1 id="PostGIS_GUC"> | |||
| <sect1info> | |||
| <abstract> | |||
| <para>This section lists custom PostGIS Grand Unified Custom Variables(GUC). These can be set globally, by database, by session or by transaction. Best set at global or database level.</para> | |||
| <para>This section lists custom PostGIS Grand Unified Custom Variables(GUC). | |||
There was a problem hiding this comment.
Suggested change
| <para>This section lists custom PostGIS Grand Unified Custom Variables(GUC). | |
| <para>This section lists custom PostGIS Grand Unified Custom Variables (GUC). |
Komzpa
reviewed
Mar 11, 2019
doc/reference_type.xml
Outdated
|
|
||
| <para><emphasis>At least as of PostgreSQL 8.3</emphasis> - Everything can be CAST to text (presumably because of the magical unknown type), so no defined CASTS for that need to be present for you to CAST an object to text.</para> | ||
| <para><emphasis>(At least as of PostgreSQL 8.3)</emphasis> Everything can be CAST to <varname>text</varname>, so CASTs to text do not need to be specified.</para> |
There was a problem hiding this comment.
Postgres 8.3 is dead since 2013.
Suggested change
| <para><emphasis>(At least as of PostgreSQL 8.3)</emphasis> Everything can be CAST to <varname>text</varname>, so CASTs to text do not need to be specified.</para> | |
| <para>Everything can be CAST to <varname>text</varname>, so CASTs to text do not need to be specified.</para> |
Komzpa
reviewed
Mar 11, 2019
doc/reference_type.xml
Outdated
| </abstract> | ||
| </sect1info> | ||
| <title>PostgreSQL PostGIS Geometry/Geography/Box Types</title> | ||
| <title>Geometry/Geography/Box Data Types</title> |
There was a problem hiding this comment.
Suggested change
| <title>Geometry/Geography/Box Data Types</title> | |
| <title>PostGIS Geometry/Geography/Box Data Types</title> |
PostGIS box != Postgres box
Komzpa
reviewed
Mar 11, 2019
doc/reference_type.xml
Outdated
| <para>box2d is a spatial data type used to represent the enclosing box of a geometry or set of geometries. ST_Extent in earlier versions prior to PostGIS 1.4 would return a box2d.</para> | ||
| <para><varname>box2d</varname> is a spatial data type used to represent | ||
| the two-dimensional enclosing box of a geometry or collection of geometries. | ||
| For example, the <varname>ST_Extent</varname> aggregate function returns a <varname>box2d</varname> object.</para> |
There was a problem hiding this comment.
instead of wrapping into varname these can be links:
Suggested change
| For example, the <varname>ST_Extent</varname> aggregate function returns a <varname>box2d</varname> object.</para> | |
| For example, the <xref linkend="ST_Extent" /> aggregate function returns a <varname>box2d</varname> object.</para> |
There was a problem hiding this comment.
Nice, definitely better. My opinion is that everything should be linked if possible, to allow easy traversal through the docs.
Komzpa
reviewed
Mar 11, 2019
doc/reference_type.xml
Outdated
| <para>box3d is a postgis spatial data type used to represent the enclosing box of a geometry or set of geometries. ST_3DExtent returns a box3d object.</para> | ||
| <para><varname>box3d</varname> is a postgis spatial data type used to represent | ||
| the three-dimensional enclosing box of a geometry or collection of geometries. | ||
| For example, the <varname>ST_3DExtent</varname> aggregate function returns a <varname>box3d</varname> object. |
There was a problem hiding this comment.
Suggested change
| For example, the <varname>ST_3DExtent</varname> aggregate function returns a <varname>box3d</varname> object. | |
| For example, the <xref linkend="ST_3DExtent" /> aggregate function returns a <varname>box3d</varname> object. |
Komzpa
reviewed
Mar 11, 2019
|
|
||
| <refpurpose> | ||
| Packages and upgrades postgis extensions (e.g. postgis_sfcgal, | ||
| postgis_topology, postgis_sfcgal) to latest available version. |
There was a problem hiding this comment.
Suggested change
| postgis_topology, postgis_sfcgal) to latest available version. | |
| postgis_topology, postgis_sfcgal, postgis_raster) to latest available version. |
|
I like this. @dr-jts wave when you feel it's ready for (intermediate) commit. |
Signed-off-by: Martin Davis <mtnclimb@gmail.com>
Signed-off-by: Martin Davis <mtnclimb@gmail.com>
|
Thanks for the detailed review, @Komzpa, and for the thumbs-up. I've made a few more small changes - hopefully they look good too. And now I'll stop until this is committed. |
|
@dr-jts merged, please continue :D |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a start on implementing improvements to the documentation suggested in ticket 4332.
The commits show the various improvements being suggested.