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

Editorial: Add ReSpec aliasing guidance in README #2421

Merged
merged 2 commits into from
Feb 6, 2025
Merged

Editorial: Add ReSpec aliasing guidance in README #2421

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c28f49b
Add respec aliasing guidance
Jan 30, 2025
cbdf517
wrong preposition, by -> for
Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,8 @@ type”](https://respec.org/xref/?term=nullable+type) and
</section>
```

In this example, "nullable" will show up in the spec text as a [ReSpec alias](https://respec.org/docs/#aliases-and-synonyms) for "nullable type" in the WebIDL spec. Aliases can only be provided for [concepts in spec](https://respec.org/docs/#concept-shorthands) (such as terms) and are helpful when you'd like the visible text for a ReSpec link to be different than the term being linked. Please note that it is not currently possible to provide an alias for an interface (e.g., #element in the DOM spec).

In some cases, a term may be defined in multiple specifications with the same
`xref` syntax. For example, [“`[=range=]`” is defined in both the DOM and
Internationalization Glossary specs](https://respec.org/xref/?term=range). The
Expand Down
Loading