Skip to content

APIDocs using shorthand type links always use shortened basename as link text #101

@sgtcoolguy

Description

@sgtcoolguy

We use a shorthand <Titanium.API.log> style link in our markdown in the apidocs and it gets converted to a link to the target API. However, it seems to typically use the basename as the link text (here it'd be "log"). I think that makes sense when linking between two segments/methods.properties of the same type/namespace, but can be confusing when linking across types (basically if the namespace differs, it feels like the full name should be used).

An example here is if I link from os.arch()'s summary to <Titanium.Platform.architecture>, the link text is simply "architecture". Now, I can use the longer markdown link syntax to work around that, but I think a good default would be to use the short name when the source and destination type/namespace are the same, but use the long API name when they differ.

Note that linking from a buffer.Buffer Node.js shim doc type summary/overview to <Titanium.Buffer>, it uses the full name. Not sure if that's because it's a type name and not a property/event/method? Or because of where the link is?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions