aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

WRITEME: example is quietly omitted when it has no snippet tags in the first excerpt

Open Laren-AWS opened this issue 6 months ago • 3 comments

When an example has no snippet tags in the first excerpt, it is quietly omitted from the README.

For example, in this Java metadata, the first excerpt is only a description, which is valid. WRITEME detects the example has having no snippets and emits a subtle and rather cryptic warning and quietly omits the example from the output.

    Java:
      versions:
        - sdk_version: 2
          github: javav2/example_code/s3
          sdkguide:
          excerpts:
            - description: Generate a pre-signed URL for an object, then download it (GET request).
            - description: Imports.
              snippet_tags:
                - presigned.java2.generatepresignedgeturlandretrieve.import
            - description: Generate the URL.
              snippet_tags:
                - presigned.java2.generatepresignedgeturlandretrieve.createpresignedurl

Expected

WRITEME digs deeper into the excerpts to find a snippet tag so it can include the example.

Laren-AWS avatar Aug 06 '24 17:08 Laren-AWS