Skip to content
Permalink
Browse files

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

* removed '>' prefix from from docs/working-with-rules

* retained the line space
  • Loading branch information...
AlokTakshak authored and platinumazure committed Jun 8, 2019
1 parent 1c43eef commit 20908a38f489c285abf8fceef4d9d13bf8b87f22
Showing with 15 additions and 15 deletions.
  1. +15 −15 docs/developer-guide/working-with-rules.md
@@ -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:

0 comments on commit 20908a3

Please sign in to comment.
You can’t perform that action at this time.