Skip to content

[Tag]: version: 3.N #27292

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

Open
story645 opened this issue Nov 8, 2023 · 4 comments
Open

[Tag]: version: 3.N #27292

story645 opened this issue Nov 8, 2023 · 4 comments
Labels
Documentation: tags tagging examples + proposing new tags

Comments

@story645
Copy link
Member

story645 commented Nov 8, 2023

Need

It's nice to have ways to highlight when something comes into the library, especially newer features xref: #15920

If we can add a tag for versions, that'll let us highlight what in the gallery came in on a specific version -> specifically new features. Tagging by version number means we don't have to move a whole bunch of tags on every new version. Adding "and add tag: N.M" to the other documenting new features instructions isn't a big deal.

Proposed solution

We should use the same format as the versioning directives, version: 3.N

@story645 story645 added the Documentation: tags tagging examples + proposing new tags label Nov 8, 2023
@rcomer
Copy link
Member

rcomer commented Nov 9, 2023

Sometimes an existing example is modified to show a new feature, e.g. #23208. Would you still add the tag in that case?

@story645
Copy link
Member Author

story645 commented Nov 9, 2023

I think so - it's still showing a feature that came in recently. I think the only complication is if an example warrants multiple version tags, making it clear which feature goes to which tag - but that may be a good usecase for putting tags in places other than the bottom if it's an example with multiple parts.

@timhoffm
Copy link
Member

timhoffm commented Nov 9, 2023

IMHO the Tag should only be set if the feature is the central aspect of the example. It should be rare that we‘ll have duplicate labels then.

More generally, labels can have two functions:

  • Show the minimal requirement needed for the example.
  • Draw attentions to new features.

The first one is not reliable, because minor aspects of the example may still need newer versions.
This leaves us with the second, so that we can always resolve to the newest version.

@story645
Copy link
Member Author

story645 commented Nov 9, 2023

the Tag should only be set if the feature is the central aspect of the example

I'm fine w/ that criteria and it fits w/ the other "versioning guidelines" criteria.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: tags tagging examples + proposing new tags
Projects
None yet
Development

No branches or pull requests

3 participants