Skip to content

README.md, TESTING.md, etc - should use merged code instead of untested code. #1324

Closed

Description

@lesv

Currently, we merge snippets (which are tested) into files that we generate our JavaDocs against. It would be great if we also did this for our all our README's as they aren't tested currently.

It should be possible to use hidden tags like:

<!-- [INCLUDE blah] -->

In any *.md file

Activity

  1. added
    type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.
    on Oct 19, 2016
  2. changed the title [-]FR: README.md, TESTING.md, etc - should use merged code instead of untested code.[/-] [+]README.md, TESTING.md, etc - should use merged code instead of untested code.[/+] on Jan 26, 2017
  3. added
    priority: p1Important issue which blocks shipping the next release. Will be fixed prior to next release.
    on Jun 12, 2017
  4. added
    priority: p2Moderately-important priority. Fix may not be included in next release.
    and removed
    priority: p1Important issue which blocks shipping the next release. Will be fixed prior to next release.
    on Jul 18, 2017
  5. danoscarmike commented on Aug 9, 2017

    @danoscarmike
    Contributor

    This has been added to our feature backlog: https://github.com/GoogleCloudPlatform/google-cloud-java/wiki/Feature-backlog. This issue will be closed but is linked in the backlog and can continue to be used for comment and discussion.

  6. added a commit that references this issue on Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions