Skip to content

Commit aea22d4

Browse files
antquinoneztmcw
authored andcommitted
docs(readme): minor style, spelling, and punctuation fixes
1 parent a4eddba commit aea22d4

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/FAQ.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
## What is `documentation`?
22

3-
This is a documentation generation system targeting JavaScript code and implemented
3+
`documentation` is a documentation generation system that targets JavaScript code; and is itself implemented
44
in JavaScript. It exposes multiple interfaces for users:
55

66
* with `npm i -g documentation`, it provides a binary for command-line usage
77
* install `documentation` with `npm` to use the node-facing interace
88

99
`documentation` runs in [node.js](https://nodejs.org/) but supports JavaScript
10-
that runs in _any environment_: you can use it to document browser libraries,
11-
server libraries, or even things that use RequireJS or other module systems.
10+
that runs in _any environment_. You can use it to document browser libraries,
11+
server libraries, and wherever RequireJS or another module system is used.
1212

1313
## How do I use `documentation`?
1414

1515
There are two main ways:
1616

1717
* You use the `documentation` command on your command-line to generate docs
18-
from your source code
18+
from your source code.
1919
* You use one of the integrations with a build system like Gulp to generate
2020
docs from source code.
2121

2222
## How does `documentation` differ from JSDoc?
2323

24-
JSDoc is both a **standard syntax for documentating code** as well as a
24+
JSDoc is both a **standard syntax for documentating code** and an
2525
application, also called `jsdoc`, that processes that syntax into documentation.
2626

2727
`documentation` uses the JSDoc syntax and provides an alternative to the `jsdoc`
@@ -35,24 +35,24 @@ documentation.
3535
* Beatiful defaults for HTML & Markdown output
3636
* Supports CommonJS `require()` syntax so that node modules can be documented
3737
by giving their `main` file
38-
* Heavily documented internally: all public and private functions in `documentation`
38+
* Extensively documented internally: all public and private functions in `documentation`
3939
are documented. [JSDoc is not well documented internally](https://github.com/jsdoc3/jsdoc/issues/839).
4040
* Robust ES6 support
4141
* [No Rhino cruft](https://github.com/jsdoc3/jsdoc/issues/942)
4242
* Uses JSON literal objects for data representation instead of the [abandoned](https://github.com/typicaljoe/taffydb/graphs/contributors)
4343
and [untagged](https://github.com/jsdoc3/jsdoc/blob/master/package.json#L25) [TaffyDB](http://www.taffydb.com/) project.
4444
* Uses high-quality node modules for syntax parsing, argument parsing, and other
4545
tasks: separates concerns so that we can focus on a robust solution
46-
* Customization points like plugins & templates are heavily documented and
47-
made to be flexible
46+
* Customization points like plugins & templates are well documented and
47+
flexible
4848

4949
## Why use `documentation` instead of writing a Markdown file by hand?
5050

51-
* `documentation` can generate multiple formats: when you create a project
52-
website, it can take the structure of your documentation and generate
53-
beautiful HTML output
54-
* The JSDoc syntax exposes a powerful, standardized type syntax to make it
55-
simple and clear to express parameter types like 'an array of strings'
51+
* `documentation` can generate multiple formats. When you create a
52+
website, `documentation` can take your documentation and generate
53+
beautiful HTML output.
54+
* The JSDoc syntax exposes a powerful, standardized type syntax to, for example,
55+
express parameter types like 'an array of strings'.
5656
as `Array<String>`, and to support custom object types with inter-linking
5757
* The [eslint valid-jsdoc rule](http://eslint.org/docs/rules/valid-jsdoc.html)
5858
makes it possible to require documentation as part of your linting step,
@@ -61,8 +61,8 @@ documentation.
6161
## Which files does documentation.js include?
6262

6363
By default, `documentation.js` follows dependencies within your source tree
64-
and excludes `node_modules` from results. This is meant to include your application
65-
code automatically but avoid documenting the random npm modules you're
64+
and excludes `node_modules` from results. This is meant to process your application
65+
code automatically but avoid documenting the npm modules you're
6666
using.
6767

6868
This means that if you point `documentation.js` at your `index.js` file and
@@ -71,7 +71,7 @@ those source files will be documented too.
7171

7272
You can customize this behavior by specifying the `--shallow` command-line
7373
option. With `--shallow` specified, dependendencies aren't followed: documentation.js
74-
documents only the files you explicitly name.
74+
processes only those files you explicitly name.
7575

7676
If you're using ES modules, you enable the option `--document-exported` to automatically
7777
document all exported bindings in your project, even if they don't have JSDoc comments.

0 commit comments

Comments
 (0)