Skip to content
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions aws_doc_sdk_examples_tools/config/sdks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -296,12 +296,12 @@ Python:
uid: "boto3"
name: "&guide-python3-api;"
301:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Various questions:

  • Why 301 and not 4?
  • Entities must be defined and I don't think these are.
  • Is "SDK for Python Async" the official name?
  • api_ref defaults to goto links, which will fail for this. Use a link_template instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SDK doesn't have an official name yet. We're currently referring to it as the Async SDK for Python, but it's a placeholder.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The most important thing to keep in mind in all decision-making is that this is a new SDK, not a new version of an existing one.

long: "&Python301long;"
short: "&Python301;"
long: "&PythonAsynclong;"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In order for these entities to resolve to something they must be define in the local phrases-code-examples.ent file in this repo. (and later in the global internal shared entities file around GA time)

short: "&PythonAsync;"
expanded:
long: "AWS SDK for Python Async"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These names should be "Async AWS SDK for Python" and "Async SDK for Python" (in my opinion). Of course, they're likely to change later anyway, but that's my thinking on it. Other than this, these changes LGTM.

short: "SDK for Python Async"
guide: "https://github.com/awslabs/aws-sdk-python"
guide: "https://github.com/awslabs/aws-sdk-python/blob/develop/dev-guide/index.md"
api_ref:
uid: "python-async"
name: "&guide-python3-async-api;"
Expand Down