-
Notifications
You must be signed in to change notification settings - Fork 63
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
Holistic id definition rules #2013
Labels
needs-triage
Automatically added to new issues. TF should triage them with proper labels
Comments
github-actions
bot
added
the
needs-triage
Automatically added to new issues. TF should triage them with proper labels
label
May 8, 2024
As sketched having our |
It sounds ok but we need to pay attention to assertion id policy as well |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
To avoid #1957 and possibly similar issues, we should be careful on the ids we choose for sections, examples, tables, figures. On one side, we can think of consistent patterns and on the other side, blacklist some.
Below are some proposals
Pattern:
ex-EXAMPLENAME
(these are TD snippets)sec-SECTIONNAME
fig-FIGURENAME
Blacklist:
title
since it is auto-generated for the document title by ReSpecThe text was updated successfully, but these errors were encountered: