Skip to content

docs: add doc examples to operations #1078

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

Merged
merged 4 commits into from
Mar 27, 2025
Merged

Conversation

kuhe
Copy link
Contributor

@kuhe kuhe commented Nov 20, 2023

Generates the ExamplesTrait data as JS @example code comment blocks for Commands (operations).

AWS Example:

/**
 *
 * @example To delete cors configuration on a bucket.
 * ```javascript
 * // The following example deletes CORS configuration on a bucket.
 * const input = {
 *   Bucket: "examplebucket"
 * };
 * const command = new DeleteBucketCorsCommand(input);
 * const response = await client.send(command);
 * /* response is
 * { /* metadata only *\/ }
 * *\/
 * ```
 *
 */
class DeleteBucketCorsCommand ...

@kuhe kuhe force-pushed the docs/examples branch 2 times, most recently from 00fe434 to 0aef2bf Compare June 12, 2024 19:20
@kuhe kuhe marked this pull request as ready for review June 12, 2024 19:21
@kuhe kuhe requested review from a team as code owners June 12, 2024 19:21
@kuhe kuhe requested a review from milesziemer June 12, 2024 19:21
@kuhe kuhe changed the title docs: WIP add doc examples to operations docs: add doc examples to operations Jun 12, 2024
@kuhe
Copy link
Contributor Author

kuhe commented Jun 14, 2024

  • todo: add unit tests

@kuhe
Copy link
Contributor Author

kuhe commented Mar 27, 2025

a few months later

@kuhe kuhe merged commit 3beeac6 into smithy-lang:main Mar 27, 2025
10 checks passed
@kuhe kuhe deleted the docs/examples branch March 27, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants