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.

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

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

Open
sgtcoolguy opened this issue Nov 17, 2020 · 0 comments

Comments

@sgtcoolguy
Copy link
Contributor

sgtcoolguy commented Nov 17, 2020

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant