Skip to content

Commit

Permalink
Documentation update (osmlab#211)
Browse files Browse the repository at this point in the history
* Compass checks catalog update

Includes 22 additional open source checks grouped by check type based on Compass checks catalog

* Update README.md

* Table

Organized available checks into a table.

* PoolSizeCheck

Updated PoolSizeCheck description.

* Strikethrough

Added strikethrough formatting for deprecated checks.

* Left align

Changed Check Name and Check Description columns to left aligned text.

* Deprecated descriptions and alignment

Updated the Check Descriptions column for deprecated checks, and changed the Check Type column to left alignment.

* Update README.md

* Created

Moved table from README.md to a separate document.

* Removed

Moved table for Currently Available Checks to a separate document.

* Title and description

Added title and description

* Description

Added description for Currently Available Checks

* GeneralizedCoastlineCheck

Added GeneralizedCoastlineCheck

* Renamed

Changed document name

* Replaced link

Replaced Available checks link under Currently Available Checks

* Added checks

Added 5 checks that still require links to documentation (docs have not yet been created)

* Moved

Moved AreasWithHighwayTagsCheck

* PedestrianAreaOverlappingEdgeCheck

Moved PedestrianAreaOverlappingEdgeCheck

* Header

Updated header

* Links

Fixed broken links to check documentation

* AreasWithHighwayTagCheck doc created

* EdgeCrossingEdgeCheck doc created

* IntersectingBuildingsCheck doc created

* SignPostCheck doc created

* UnusualLayerTagsCheck doc created

* Added missing docs

* Updated available_checks.md

* Revised docs for AreasWithHighwayTagCheck, EdgeCrossingEdgeCheck, IntersectingBuildingsCheck, SignPostCheck, and UnusualLayerTagsCheck.

* Revised doc for IntersectingBuildingCheck

* Revised docs for five checks

* Revised doc for IntersectingBuildingsCheck.

* Revised doc for IntersectingBuildingsCheck.

* Updated description for GeneralizedCoastlineCheck.

* Updated available_checks.md
  • Loading branch information
maraarae authored and danielduhh committed Oct 29, 2019
1 parent c7bd512 commit 01a8766
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/available_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ This document is a list of tables with a description and link to documentation f
## Nodes
| Check Name | Check Description |
| :--------- | :---------------- |
| [AddressPointMatch](checks/addressPointMatch.md) | The purpose of this check is to identify improperly tagged street names (addr:street) on features that already have an addr:housenumber tag. This includes cases where the addr:street tag doesn't exist or is null. |
| [AddressStreetNameCheck](checks/addressStreetNameCheck.md) | The purpose of this check is to identify nodes with addr:street names that don't match the surrounding roads. |
| [DuplicateNodeCheck](docs/checks/duplicateNodeCheck.md) | The purpose of this check is to identify Nodes that are in the exact same location. |
| [InvalidMiniRoundaboutCheck](checks/invalidMiniRoundaboutCheck.md) | The purpose of this check is to identify invalid mini-roundabouts (i.e. roundabouts that share the same rules as other roundabouts, but present as painted circles rather than physical circles). |
| [OrphanNodeCheck](tutorials/tutorial2-OrphanNodeCheck.md) | The purpose of this check is to identify untagged and unconnected Nodes in OSM. |

## Points
| Check Name | Check Description |
| :--------- | :---------------- |
| [AddressPointMatch](checks/addressPointMatch.md) | The purpose of this check is to identify improperly tagged street names (addr:street) on features that already have an addr:housenumber tag. This includes cases where the addr:street tag doesn't exist or is null. |
| [AddressStreetNameCheck](checks/addressStreetNameCheck.md) | The purpose of this check is to identify nodes with addr:street names that don't match the surrounding roads. |
| [DuplicatePointCheck](checks/duplicatePointCheck.md) | The purpose of this check is to identify Points in OSM that are in the same location. |


Expand Down

0 comments on commit 01a8766

Please sign in to comment.