Skip to content

Commit

Permalink
Editorial: Add ReSpec aliasing guidance in README (#2421)
Browse files Browse the repository at this point in the history
Co-authored-by: Rahim Abdi <[email protected]>
  • Loading branch information
rahimabdi and Rahim Abdi authored Feb 6, 2025
1 parent a2d34fe commit 5b1bdf0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
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

0 comments on commit 5b1bdf0

Please sign in to comment.