Skip to content

Commit

Permalink
docs(core): docs for fingerprint are incorrect (aws#26353)
Browse files Browse the repository at this point in the history
This PR fixes a document for `fingerprint` in `core` module, because the caller's comments did not modify it.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
go-to-k authored and bmoffatt committed Jul 28, 2023
1 parent e6ccf52 commit 55d307b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions packages/aws-cdk-lib/core/lib/fs/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ export class FileSystem {
/**
* Produces fingerprint based on the contents of a single file or an entire directory tree.
*
* Line endings are converted from CRLF to LF.
*
* The fingerprint will also include:
* 1. An extra string if defined in `options.extra`.
* 2. The set of exclude patterns, if defined in `options.exclude`
* 3. The symlink follow mode value.
* 2. The symlink follow mode value.
*
* @param fileOrDirectory The directory or file to fingerprint
* @param options Fingerprinting options
Expand Down

0 comments on commit 55d307b

Please sign in to comment.