Skip to content

Commit

Permalink
Fix docs to refer to use the lt attribute, as has been required for y…
Browse files Browse the repository at this point in the history
…ears. Fixes #2604
  • Loading branch information
tabatkins committed Jan 21, 2025
1 parent 8825cf0 commit 980fafc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -3723,10 +3723,10 @@ interface Foo {
```

To have Bikeshed recognize a definition for the `bar()` method placed elsewhere,
it must look something like `<dfn method for=Foo title="bar(baz, qux)">bar(DOMString baz, optional long qux)</dfn>`.
it must look something like `<dfn method for=Foo lt="bar(baz, qux)">bar(DOMString baz, optional long qux)</dfn>`.

Additionally, it *should* define alternate linking texts for omittable arguments,
like `<dfn method for=Foo title="bar(baz, qux)|bar(baz)">bar(DOMString baz, optional long qux)</dfn>`.
like `<dfn method for=Foo lt="bar(baz, qux)|bar(baz)">bar(DOMString baz, optional long qux)</dfn>`.
This way any valid call signature can be used to autolink.
Note that arguments are omittable if they're marked with `optional`, or are variadic (like `long... qux`), or have a default value.
Nullable arguments (like `long? qux`) are not omittable.
Expand Down

0 comments on commit 980fafc

Please sign in to comment.