Skip to content

Commit dcf4b52

Browse files
committed
Refactor some docs
1 parent 766c63c commit dcf4b52

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

readme.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

11-
**[unist][]** utility to pretty print the positional information of a node.
11+
[unist][] utility to pretty print the positional info of a node.
1212

1313
## Contents
1414

@@ -39,7 +39,7 @@ For example, when throwing errors or warning messages about something.
3939
## Install
4040

4141
This package is [ESM only][esm].
42-
In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
42+
In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with [npm][]:
4343

4444
```sh
4545
npm install unist-util-stringify-position
@@ -83,7 +83,7 @@ There is no default export.
8383

8484
### `stringifyPosition(node|position|point)`
8585

86-
Stringify a [point][], [position][], or a [node][].
86+
Stringify a point, position, or node.
8787

8888
###### Parameters
8989

@@ -96,22 +96,23 @@ Stringify a [point][], [position][], or a [node][].
9696

9797
###### Returns
9898

99-
`string?` — A range `ls:cs-le:ce` (when given `node` or `position`) or a point
100-
`l:c` (when given `point`), where `l` stands for line, `c` for column, `s` for
101-
`start`, and `e` for end.
99+
Pretty printed positional info of a node (`string`).
100+
In the format of a range `ls:cs-le:ce` (when given `node` or `position`) or a
101+
point `l:c` (when given `point`), where `l` stands for line, `c` for column, `s`
102+
for `start`, and `e` for end.
102103
An empty string (`''`) is returned if the given value is neither `node`,
103104
`position`, nor `point`.
104105

105106
## Types
106107

107108
This package is fully typed with [TypeScript][].
108-
There are no additional types exported.
109+
It exports no additional types.
109110

110111
## Compatibility
111112

112113
Projects maintained by the unified collective are compatible with all maintained
113114
versions of Node.js.
114-
As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
115+
As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+.
115116
Our projects sometimes work with older versions, but this is not guaranteed.
116117

117118
## Security

0 commit comments

Comments
 (0)