Skip to content

Commit

Permalink
Clarify dimension doc.
Browse files Browse the repository at this point in the history
Fix doc creation script.
  • Loading branch information
abellgithub committed Sep 6, 2019
1 parent a27c1be commit 23fb164
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
9 changes: 6 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,15 @@ def read_version(filename):
# project(PDAL VERSION 0.9.8 LANGUAGES CXX C)
data = open(filename).readlines()

token = 'VERSION'
token = 'PDAL VERSION'

version = None
for line in data:
if str(token) in line:
version = re.search(r'\d.\d.\d', line).group(0)
break
match = re.search(r'\d.\d.\d', line)
if match is not None:
version = match.group(0)
break
return version

release = read_version('../CMakeLists.txt')
Expand Down
14 changes: 11 additions & 3 deletions doc/dimensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@
Dimensions
===============================================================================

PDAL dimensions describe the combination of data's type, size, and meaning. The
following table provides a list of known dimension names you can use in
:ref:`filters`, :ref:`writers`, and :ref:`readers` descriptions.
All point data in PDAL is stored as a set of dimensions. Dimensions
have a name and a data type. The data type is determined at runtime, but
a default data type for each dimension is listed below, along with the name
of the dimension and its description.

The following table provides a list of known dimension names you can use in
:ref:`filters`, :ref:`writers`, and :ref:`readers`.

.. note::
Types are default types. Stage developers should set the dimension type
explicitly if the default dimension isn't suitable.


.. csv-table::
Expand Down

0 comments on commit 23fb164

Please sign in to comment.