Update wording relating to positional info

Related to syntax-tree/unist@f2b8587.

Author: wooorm

index.js

@@ -12,37 +12,37 @@ function stringify(value) {
 
   /* Node. */
   if (own.call(value, 'position') || own.call(value, 'type')) {
-    return location(value.position);
+    return position(value.position);
   }
 
-  /* Location. */
+  /* Position. */
   if (own.call(value, 'start') || own.call(value, 'end')) {
-    return location(value);
+    return position(value);
   }
 
-  /* Position. */
+  /* Point. */
   if (own.call(value, 'line') || own.call(value, 'column')) {
-    return position(value);
+    return point(value);
   }
 
   /* ? */
   return null;
 }
 
-function position(pos) {
-  if (!pos || typeof pos !== 'object') {
-    pos = {};
+function point(point) {
+  if (!point || typeof point !== 'object') {
+    point = {};
   }
 
-  return index(pos.line) + ':' + index(pos.column);
+  return index(point.line) + ':' + index(point.column);
 }
 
-function location(loc) {
-  if (!loc || typeof loc !== 'object') {
-    loc = {};
+function position(pos) {
+  if (!pos || typeof pos !== 'object') {
+    pos = {};
   }
 
-  return position(loc.start) + '-' + position(loc.end);
+  return point(pos.start) + '-' + point(pos.end);
 }
 
 function index(value) {

package.json

@@ -1,12 +1,13 @@
 {
   "name": "unist-util-stringify-position",
   "version": "1.1.1",
-  "description": "Stringify a Unist node, location, or position",
+  "description": "Stringify a Unist node, position, or point",
   "license": "MIT",
   "keywords": [
     "unist",
     "position",
     "location",
+    "point",
     "node",
     "stringify",
     "tostring",

readme.md

@@ -1,6 +1,6 @@
 # unist-util-stringify-position [![Build Status][build-badge]][build-page] [![Coverage Status][coverage-badge]][coverage-page]
 
-Stringify a [**Unist**][unist] [position][] or [location][].
+Stringify a [**Unist**][unist] [`Position`][position] or [`Point`][point].
 
 ## Installation
 
@@ -15,13 +15,16 @@ npm install unist-util-stringify-position
 ```javascript
 var stringify = require('unist-util-stringify-position');
 
-stringify({line: 2, column: 3 }); //=> '2:3'
+// Point
+stringify({line: 2, column: 3}); //=> '2:3'
 
+// Position
 stringify({
   start: {line: 2},
   end: {line: 3}
 }); //=> '2:1-3:1'
 
+// Node
 stringify({
   type: 'text',
   value: '!',
@@ -34,27 +37,27 @@ stringify({
 
 ## API
 
-### `stringifyPosition(node|location|position)`
+### `stringifyPosition(node|position|point)`
 
-Stringify one position, a location (start and end positions), or
-a node’s location.
+Stringify one point, a position (start and end points), or
+a node’s position.
 
 ###### Parameters
 
 *   `node` ([`Node`][node])
     — Node whose `'position'` property to stringify
-*   `location` ([`Location`][location])
-    — Location whose `'start'` and `'end'` positions to stringify
 *   `position` ([`Position`][position])
-    — Location whose `'line'` and `'column'` to stringify
+    — Position whose `'start'` and `'end'` points to stringify
+*   `point` ([`Point`][point])
+    — Point whose `'line'` and `'column'` to stringify
 
 ###### Returns
 
 `string?` — A range `ls:cs-le:ce` (when given `node` or
-`location`) or a point `l:c` (when given `position`), where `l` stands
+`position`) or a point `l:c` (when given `point`), where `l` stands
 for line, `c` for column, `s` for `start`, and `e` for
 end.  `null` is returned if the given value is neither `node`,
-`location`, nor `position`.
+`position`, nor `point`.
 
 ## License
 
@@ -80,6 +83,6 @@ end.  `null` is returned if the given value is neither `node`,
 
 [node]: https://github.com/syntax-tree/unist#node
 
-[location]: https://github.com/syntax-tree/unist#location
-
 [position]: https://github.com/syntax-tree/unist#position
+
+[point]: https://github.com/syntax-tree/unist#point

test.js

@@ -19,7 +19,7 @@ test('stringifyPosition', function (t) {
   t.equal(
     stringify({type: 'text', position: 3}),
     '1:1-1:1',
-    'should return range for `node` with invalid `position` #1'
+    'should return a range for `node` with invalid `position` #1'
   );
 
   t.equal(
@@ -28,7 +28,7 @@ test('stringifyPosition', function (t) {
       position: {start: {}, end: {}}
     }),
     '1:1-1:1',
-    'should return range for `node` with invalid `position` #2'
+    'should return a range for `node` with invalid `position` #2'
   );
 
   t.equal(
@@ -40,7 +40,7 @@ test('stringifyPosition', function (t) {
       }
     }),
     '1:1-1:1',
-    'should return range for `node` with invalid `position` #3'
+    'should return a range for `node` with invalid `position` #3'
   );
 
   t.equal(
@@ -52,25 +52,25 @@ test('stringifyPosition', function (t) {
       }
     }),
     '2:5-2:6',
-    'should return range for `node` with valid `position`'
+    'should return a range for `node` with valid `position`'
   );
 
   t.equal(
     stringify({start: null, end: null}),
     '1:1-1:1',
-    'should return a range for a `location` without `position`s'
+    'should return a range for a `position` without `point`s'
   );
 
   t.equal(
     stringify({start: 3, end: 6}),
     '1:1-1:1',
-    'should return range for `location` with invalid `position`s #1'
+    'should return a range for `position` with invalid `point`s #1'
   );
 
   t.equal(
     stringify({start: {}, end: {}}),
     '1:1-1:1',
-    'should return range for `location` with invalid `position`s #1'
+    'should return range for `position` with invalid `point`s #1'
   );
 
   t.equal(
@@ -79,7 +79,7 @@ test('stringifyPosition', function (t) {
       end: {line: null, column: null}
     }),
     '1:1-1:1',
-    'should return range for `location` with invalid `position`s #3'
+    'should return range for `position` with invalid `point`s #3'
   );
 
   t.equal(
@@ -88,37 +88,37 @@ test('stringifyPosition', function (t) {
       end: {line: 2, column: 6}
     }),
     '2:5-2:6',
-    'should return range for `location` with valid `position`s'
+    'should return range for `position` with valid `point`s'
   );
 
   t.equal(
     stringify({line: null, column: null}),
     '1:1',
-    'should return a point for a `position` without indices'
+    'should return a point for a `point` without indices'
   );
 
   t.equal(
     stringify({line: 'foo', column: 'bar'}),
     '1:1',
-    'should return a point for a `position` with invalid indices #1'
+    'should return a point for a `point` with invalid indices #1'
   );
 
   t.equal(
     stringify({line: 4}),
     '4:1',
-    'should return a point for a partially valid `position` #1'
+    'should return a point for a partially valid `point` #1'
   );
 
   t.equal(
     stringify({column: 12}),
     '1:12',
-    'should return a point for a partially valid `position` #1'
+    'should return a point for a partially valid `point` #1'
   );
 
   t.equal(
     stringify({line: 5, column: 2}),
     '5:2',
-    'should return a point for a valid `position`'
+    'should return a point for a valid `point`'
   );
 
   t.end();