Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect service names in reference documentation content #1849

Open
shepazon opened this issue Dec 18, 2024 · 0 comments
Open

Incorrect service names in reference documentation content #1849

shepazon opened this issue Dec 18, 2024 · 0 comments
Labels
bug This issue is a bug. needs-triage This issue or PR still needs to be triaged.

Comments

@shepazon
Copy link
Contributor

shepazon commented Dec 18, 2024

Describe the bug

In many places throughout the Swift SDK Reference, places where the name of the service should appear, the text AWSGirApiService appears instead. For example, see the documentation of the Lambda function createFunction(input:).

In other cases, the name is a little less confusing, but still unexpected, such as the name "CodeDeploy_20141006" being used in places through the AWS CodeDeploy documentation.

This needs to be corrected because it's very confusing, and it happens throughout the reference.

Expected Behavior

Service names (or module names) should always appear correctly in the Reference.

Current Behavior

The text "AWSGirApiService" is used instead. I don't know where that comes from, but it needs to go away.

Reproduction Steps

  1. Open the reference to a page that uses the weird word.
  2. Read it.
  3. Puzzle over the mystery of it all.
  4. Question your sanity.
  5. Re-read the text to be sure you didn't imagine things.
  6. Scratch your head, wondering if the Reference knows something you don't know.
  7. Finally, accept that something is definitely wrong.

Possible Solution

I assume this is an auto-generation glitch of some kind. Fix that.

Additional Information/Context

No response

AWS SWIFT SDK version used

1.0.63

Compiler and Version used

n/a

Operating System and version

macOS 15.1

@shepazon shepazon added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Development

No branches or pull requests

1 participant