Skip to content

Commit 9ec18a5

Browse files
committed
Add Tania's comments for future reference
1 parent 404b6b9 commit 9ec18a5

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

docs/tasks/includes/_node-build.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,11 @@ const manifest = new ManifestBuilder({
2929
});
3030
```
3131

32-
FROM SIGNING:
33-
3432
Use the `c2pa.sign()` method to sign an ingredient, either locally if you have a signing certificate and key available, or by using a remote signing API.
3533

3634
## Signing a stream
3735

38-
If you have an asset file's data loaded into memory, you can sign the the asset using the loaded stream (buffer).
36+
If you have an asset file's data loaded into a stream, you can use it to sign the asset
3937

4038
**NOTE**: Signing using a stream is currently supported only for `image/jpeg` and `image/png` data. For all other file types, use the [file-based approach](#signing-files) .
4139

docs/tasks/includes/_node-setup.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,12 @@ import { createC2pa } from 'c2pa-node';
55
import { readFile } from 'node:fs/promises';
66

77
const c2pa = createC2pa();
8-
```
8+
```
9+
10+
<!-- Comments from @tmathern
11+
12+
`import { readFile } from 'node:fs/promises';` looks unusual, but if it's in our code this way and works I would leave it.
13+
14+
More usual is `... from fs.promises`.
15+
16+
-->

docs/tasks/includes/_python-read.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,8 @@ try:
1919

2020
except Exception as err:
2121
print(err)
22-
```
22+
```
23+
24+
<!--
25+
May want to add that the `path` param needs to be a valid path (since we don't revalidate in the example), and `mimeType` a valid and supported mimetype (again because in the example we don't revalidate and/or check for undefined/null).
26+
-->

0 commit comments

Comments
 (0)