Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: removed '>' prefix from from docs/working-with-rules #11818

Merged
merged 2 commits into from Jun 8, 2019
Merged

Docs: removed '>' prefix from from docs/working-with-rules #11818

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54c68df
removed '>' prefix from from docs/working-with-rules
AlokTakshak Jun 8, 2019
0b3c60a
retained the line space
AlokTakshak Jun 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/developer-guide/working-with-rules.md
View file
Open in desktop
Expand Up @@ -412,21 +412,21 @@ Once you have an instance of `SourceCode`, you can use the methods on it to work
* `getIndexFromLoc(loc)` - returns the index of a given location in the source code, where `loc` is an object with a 1-based `line` key and a 0-based `column` key.
* `commentsExistBetween(nodeOrToken1, nodeOrToken2)` - returns `true` if comments exist between two nodes.

> `skipOptions` is an object which has 3 properties; `skip`, `includeComments`, and `filter`. Default is `{skip: 0, includeComments: false, filter: null}`.
>
> * `skip` is a positive integer, the number of skipping tokens. If `filter` option is given at the same time, it doesn't count filtered tokens as skipped.
> * `includeComments` is a boolean value, the flag to include comment tokens into the result.
> * `filter` is a function which gets a token as the first argument, if the function returns `false` then the result excludes the token.
>
> `countOptions` is an object which has 3 properties; `count`, `includeComments`, and `filter`. Default is `{count: 0, includeComments: false, filter: null}`.
>
> * `count` is a positive integer, the maximum number of returning tokens.
> * `includeComments` is a boolean value, the flag to include comment tokens into the result.
> * `filter` is a function which gets a token as the first argument, if the function returns `false` then the result excludes the token.
>
> `rangeOptions` is an object which has 1 property: `includeComments`.
>
> * `includeComments` is a boolean value, the flag to include comment tokens into the result.
`skipOptions` is an object which has 3 properties; `skip`, `includeComments`, and `filter`. Default is `{skip: 0, includeComments: false, filter: null}`.

* `skip` is a positive integer, the number of skipping tokens. If `filter` option is given at the same time, it doesn't count filtered tokens as skipped.
* `includeComments` is a boolean value, the flag to include comment tokens into the result.
* `filter` is a function which gets a token as the first argument, if the function returns `false` then the result excludes the token.

`countOptions` is an object which has 3 properties; `count`, `includeComments`, and `filter`. Default is `{count: 0, includeComments: false, filter: null}`.

* `count` is a positive integer, the maximum number of returning tokens.
* `includeComments` is a boolean value, the flag to include comment tokens into the result.
* `filter` is a function which gets a token as the first argument, if the function returns `false` then the result excludes the token.

`rangeOptions` is an object which has 1 property: `includeComments`.

* `includeComments` is a boolean value, the flag to include comment tokens into the result.

There are also some properties you can access:

Expand Down