docs(core): docs for fingerprint are incorrect (#26353)

go-to-k · web-flow · commit 97af59efaa27 · 2023-07-14T12:51:23.000Z
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*
diff --git a/packages/aws-cdk-lib/core/lib/fs/index.ts b/packages/aws-cdk-lib/core/lib/fs/index.ts
@@ -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

Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,11 @@ export class FileSystem {`
`26`	`26`	`/**`
`27`	`27`	`* Produces fingerprint based on the contents of a single file or an entire directory tree.`
`28`	`28`	`*`
	`29`	`+ * Line endings are converted from CRLF to LF.`
	`30`	`+ *`
`29`	`31`	`* The fingerprint will also include:`
`30`	`32`	* 1. An extra string if defined in `options.extra`.
`31`		- * 2. The set of exclude patterns, if defined in `options.exclude`
`32`		`- * 3. The symlink follow mode value.`
	`33`	`+ * 2. The symlink follow mode value.`
`33`	`34`	`*`
`34`	`35`	`* @param fileOrDirectory The directory or file to fingerprint`
`35`	`36`	`* @param options Fingerprinting options`