From 7eae06bb1cd49c6613bfbf792b81ee83a98bc112 Mon Sep 17 00:00:00 2001 From: Steven Meyer <108885656+meyertst-aws@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:46:13 -0400 Subject: [PATCH] updates for review. --- .tools/readmes/README.md | 2 +- .tools/readmes/includes/run_instructions.jinja2 | 12 ++++++++++++ cpp/example_code/ses/README.md | 16 +++++++++++++--- 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/.tools/readmes/README.md b/.tools/readmes/README.md index 6297a00d80b..ae98f589897 100644 --- a/.tools/readmes/README.md +++ b/.tools/readmes/README.md @@ -37,7 +37,7 @@ authored for the SOS project. After you have authored metadata and snippet tags for your examples, run the following command in the root folder of the repo: ``` -python .doc_gen/readmes/writeme.py +python .tools/readmes/writeme.py ``` WRITME reads metadata and config data and generates a README in the service diff --git a/.tools/readmes/includes/run_instructions.jinja2 b/.tools/readmes/includes/run_instructions.jinja2 index 82531774bb6..7564d2d9c03 100644 --- a/.tools/readmes/includes/run_instructions.jinja2 +++ b/.tools/readmes/includes/run_instructions.jinja2 @@ -35,6 +35,18 @@ dotnet run Alternatively, you can run the example from within your IDE. +{% endif %} + +{% if lang_config['name'] == 'C++' %} +An executable is built for each source file. These executables are located in the build folder and have +"run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions. + +For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command +will display any required arguments. + +``` +./run_my_action +``` {% endif %} {{ customs['instructions'] -}} diff --git a/cpp/example_code/ses/README.md b/cpp/example_code/ses/README.md index 68daacad62a..af3be3c6cf0 100644 --- a/cpp/example_code/ses/README.md +++ b/cpp/example_code/ses/README.md @@ -1,4 +1,4 @@ - + # Amazon SES code examples for the SDK for C++ ## Overview @@ -53,7 +53,7 @@ Code excerpts that show you how to call individual service functions. * [Delete an identity](delete_identity.cpp#L23) (`DeleteIdentity`) * [Get an existing email template](get_template.cpp#L24) (`GetTemplate`) * [List identities](list_identities.cpp#L23) (`ListIdentities`) -* [List receipt filters](list_receipt_filters.cpp#L25) (`ListReceiptFilters`) +* [List receipt filters](list_receipt_filters.cpp#L24) (`ListReceiptFilters`) * [Send email](send_email.cpp#L28) (`SendEmail`) * [Send templated email](send_templated_email.cpp#L25) (`SendTemplatedEmail`) * [Update an email template](update_template.cpp#L24) (`UpdateTemplate`) @@ -70,6 +70,16 @@ Sample applications that work across multiple AWS services. ### Instructions + +An executable is built for each source file. These executables are located in the build folder and have +"run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions. + +For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command +will display any required arguments. + +``` +./run_my_action +``` @@ -96,7 +106,7 @@ Sample applications that work across multiple AWS services. * [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/Welcome.html) * [Amazon SES API Reference](https://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html) -* [SDK for C++ Amazon SES reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-ses/html/annotated.html) +* [SDK for C++ Amazon SES reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-email/html/annotated.html)