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.

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

Added docs about the new censor function. #553

Merged
merged 3 commits into from Nov 22, 2018

Conversation

@mcollina
Copy link
Member

commented Nov 22, 2018

We missed to update the docs.

@mcollina mcollina requested review from jsumners and davidmarkclements Nov 22, 2018

@jsumners
Copy link
Collaborator

left a comment

LGTM with nit. Might also want to mention that the function must be synchronous.

docs/api.md Outdated
@@ -105,7 +105,9 @@ Each path must be a string using a syntax which corresponds to JavaScript dot an

If an object is supplied, three options can be specified:
* `paths` (array): Required. An array of paths. See [redaction - Path Syntax ⇗](/docs/redaction.md#paths) for specifics.
* `censor` (String): Optional. A value to overwrite key which are to be redacted. Default: `'[Redacted]'`
* `censor` (String|Function): Optional. A value to overwrite key which are to be redacted.

This comment has been minimized.

Copy link
@jsumners

jsumners Nov 22, 2018

Collaborator

“key” => “keys”

@mcollina

This comment has been minimized.

Copy link
Member Author

commented Nov 22, 2018

PTAL

@mcollina mcollina force-pushed the censor-doc branch from ba6c774 to f05cb2f Nov 22, 2018

docs/api.md Outdated Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
davidmarkclements and others added 2 commits Nov 22, 2018
Update docs/api.md
Co-Authored-By: mcollina <matteo.collina@gmail.com>
Update docs/api.md
Co-Authored-By: mcollina <matteo.collina@gmail.com>

changes applied

@mcollina mcollina merged commit c2173f8 into master Nov 22, 2018

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details

@mcollina mcollina deleted the censor-doc branch Nov 22, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.