AtHeartEngineer/kami
1
0
Fork 0
mirror of https://github.com/JHUAPL/kami.git synced 2026-01-07 22:13:51 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(gridx): Remove documentation for nonexistent option

Browse Source
This commit is contained in:
James P. Howard, II
2023-01-20 10:50:51 -05:00
parent 2ead0b30e0
commit c08f9509e5
1 changed files with 1 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/kami/grid.h
View File

@@ -118,8 +118,7 @@ namespace kami {
* @brief Find the distance between two points
*
* @details Find the distance between two points using the
* specified metric. There are three options provided by
* the `GridDistanceType` class.
* specified metric.
*
* However, the coordinate class is not aware of the
* properties of the `GridDomain` it is operating on. Accordingly,
@@ -127,7 +126,6 @@ namespace kami {
* and toroidal wrapping of the underlying `GridDomain`.
*
* @param p the point to measure the distance to
* @param distance_type specify the distance type
*
* @returns the distance as a `double`
*/