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

Expose "aliased_html" in doc JSON, make "aliased" field nullable #10117

Merged
merged 1 commit into from
Jan 6, 2021

Conversation

oprypin
Copy link
Member

@oprypin oprypin commented Dec 20, 2020

I split out this change from #10109 because it's not strictly related.

Same as there, I need this for my external doc generator, to detect where Crystal decides to linkify types and such.

Example output:

"alias": true,
"aliased": "Slice(UInt8)",
"aliased_html": "<a href=\"Slice.html\">Slice</a>(<a href=\"UInt8.html\">UInt8</a>)",
"alias": false,
"aliased": null,
"aliased_html": null,

Before:

"alias": true,
"aliased": "Slice(UInt8)",
"alias": false,
"aliased": "",

This can be useful for external doc generators, to detect where Crystal decides to linkify types and such.
oprypin added a commit to mkdocstrings/crystal that referenced this pull request Jan 2, 2021
@oprypin
Copy link
Member Author

oprypin commented Jan 6, 2021

Ping :S
This is a really small one

@asterite asterite merged commit 554400b into crystal-lang:master Jan 6, 2021
@asterite asterite added this to the 1.0.0 milestone Jan 6, 2021
@oprypin
Copy link
Member Author

oprypin commented Jan 6, 2021

Thank you!

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

Successfully merging this pull request may close these issues.

3 participants