Skip to content

Commit 384bcb3

Browse files
committed
fix: Docs review comments
1 parent 2b288f1 commit 384bcb3

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

examples/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The examples use asset files from the `tests/fixtures` directory, save the resul
88
The [`examples/sign.py`](https://github.com/contentauth/c2pa-python/blob/main/examples/sign.py) script shows how to sign an asset with a C2PA manifest and verify the asset.
99

1010

11-
The `examples/sign.py` script shows how to sign an asset with a C2PA manifest and verify it using a callback signer. Callback signers let you define signing logic, eg. where to load keys from.
11+
The `examples/sign.py` script shows how to sign an asset with a C2PA manifest and verify it using a callback signer. Callback signers let you define signing logic, for example where to load keys from.
1212

1313
The `examples/sign_info.py` script shows how to sign an asset with a C2PA manifest and verify it using a "default" signer created with the needed signer information.
1414
These statements create a `builder` object with the specified manifest JSON (omitted in the snippet below), call `builder.sign()` to sign and attach the manifest to the source file, `tests/fixtures/C.jpg`, and save the signed asset to the output file, `output/C_signed.jpg`:
@@ -82,15 +82,15 @@ python examples/training.py
8282

8383
### Run the signing and verification example
8484

85-
In this example, signing is done with a Signer created using SignerInfo:
85+
In this example, `SignerInfo` creates a `Signer` object that signs the manifest.
8686

8787
```bash
8888
python examples/sign_info.py
8989
```
9090

9191
### Run the callback signing and verification example
9292

93-
In this example, signing is done using a callback signer:
93+
In this example, a callback signer is the signer:
9494

9595
```bash
9696
python examples/sign.py

examples/sign_info.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010
# specific language governing permissions and limitations under
1111
# each license.
1212

13+
###############################################################
14+
# This example shows an "older" way of signing,
15+
# and is left here as reference.
16+
# Please refer to sign.py for the recommended implementation.
17+
###############################################################
18+
1319
# This example shows how to sign an image with a C2PA manifest
1420
# and read the metadata added to the image.
1521

0 commit comments

Comments
 (0)