You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
prefixing them with some seldom used character like $
assuming all text inside inline code that matches an api entry's name is referring to that api entry
Both these approaches will need to consider cases where a name matches two entries, such as $Card matching both the Card type entry and Card namespace entry.
Linking to a specific overload of a function/function type is also currently not possible but could be supported either by adding a name field to overloads or indexing overloads by number.
The text was updated successfully, but these errors were encountered:
I'm considering going with the second idea, but adding bold text to refer to non-code entries.
Essentially, if a text is an InlineCode and it matches a namespace, function, or constant's name, it's assumed to be referring to that namespace/function/constant entry.
Meanwhile if it is a BoldText and it matches a type, enum, or tag's name, it's assumed to be referring to that type/enum/tag.
This naturally differentiates Card (the namespace) and Card (the type).
This means for the specs, there should be no duplicate names among functions, constants, and namespaces. Likewise among types, enums, and tags.
Currently, linking to other entries involves writing out their relative link. A shorthand might be preferred.
Some possible ways would be:
$
inline code
that matches an api entry's name is referring to that api entryBoth these approaches will need to consider cases where a name matches two entries, such as $Card matching both the
Card
type entry andCard
namespace entry.Linking to a specific overload of a function/function type is also currently not possible but could be supported either by adding a name field to overloads or indexing overloads by number.
The text was updated successfully, but these errors were encountered: