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.

Sign up for GitHub

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

Jump to bottom

Holistic id definition rules #2013

Open
egekorkan opened this issue May 8, 2024 · 2 comments
Open

Holistic id definition rules #2013

egekorkan opened this issue May 8, 2024 · 2 comments
Labels
needs-triage Automatically added to new issues. TF should triage them with proper labels

Comments

@egekorkan
Copy link
Contributor

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:

  • Examples ex-EXAMPLENAME (these are TD snippets)
  • Sections sec-SECTIONNAME
  • Figure fig-FIGURENAME

Blacklist:

  • title since it is auto-generated for the document title by ReSpec
@github-actions github-actions bot added the needs-triage Automatically added to new issues. TF should triage them with proper labels label May 8, 2024
@egekorkan egekorkan mentioned this issue May 8, 2024
Merged
@danielpeintner
Copy link
Contributor

As sketched having our own prefix might be a good solution. Having said that, we could also add something based on the actual document like "td-", "arch-" etc . Not sure though if this is an overkill 🙈

@egekorkan
Copy link
Contributor Author

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
Assignees
No one assigned
Labels
needs-triage Automatically added to new issues. TF should triage them with proper labels
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@danielpeintner @egekorkan