[pdal-commits] [PDAL/PDAL] 77d858: Improve stage overview documentation

[GitHub]

  Branch: refs/heads/filter-grouping-and-definition-lists
  Home:   https://github.com/PDAL/PDAL
  Commit: 77d858d8006502387c28fa2d1ea908b4062a20f2
      https://github.com/PDAL/PDAL/commit/77d858d8006502387c28fa2d1ea908b4062a20f2
  Author: Bradley J Chambers <brad.chambers at gmail.com>
  Date:   2018-03-30 (Fri, 30 Mar 2018)

  Changed paths:
    M doc/references.rst
    M doc/stages/filters.gridprojection.rst
    M doc/stages/filters.mongus.rst
    M doc/stages/filters.movingleastsquares.rst
    M doc/stages/filters.poisson.rst
    M doc/stages/filters.rst
    M doc/stages/readers.rst
    M doc/stages/writers.bpf.rst
    M doc/stages/writers.rst
    A doc/stages/writers.sbet.rst
    M filters/ApproximateCoplanarFilter.cpp
    M filters/AssignFilter.cpp
    M filters/ClusterFilter.cpp
    M filters/ELMFilter.cpp
    M filters/EigenvaluesFilter.cpp
    M filters/EstimateRankFilter.cpp
    M filters/HAGFilter.cpp

  Log Message:
  -----------
  Improve stage overview documentation

Convert from bulleted TOC stage listings to definition lists, whereby the
filter name and link are shown as the "term" and a brief stage description is
provided as the definition. The intent is to provide a simpler overview of our
growing list of stages.

Filters are also broken into some categories that attempt to capture what they
do to the data (like creating new dimensions, culling points, etc.).