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

docs: add doc examples to operations #1078

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

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 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
Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
@kuhe
Copy link
Contributor Author

kuhe commented Jun 14, 2024

  • todo: add unit tests

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