Skip to content

Add documentation for NoReturn and Void#14817

Merged
straight-shoota merged 4 commits intocrystal-lang:masterfrom
nobodywasishere:nobody/pseudo_noreturn_void
Aug 19, 2024
Merged

Add documentation for NoReturn and Void#14817
straight-shoota merged 4 commits intocrystal-lang:masterfrom
nobodywasishere:nobody/pseudo_noreturn_void

Conversation

@nobodywasishere
Copy link
Contributor

@nobodywasishere nobodywasishere commented Jul 20, 2024

Resolves #13272

It works, and I've copied the NoReturn docs from the crystal book. Only issue is that the backticks references to NoReturn and Void don't work without including both the actual type and the pseudo type, resulting in two of each showing up in the sidebar.

nobodywasishere and others added 2 commits July 22, 2024 09:38
Co-authored-by: Johannes Müller <straightshoota@gmail.com>
Co-authored-by: Sijawusz Pur Rahnama <sija@sija.pl>
@nobodywasishere
Copy link
Contributor Author

There's no obvious way to fix the backtick links I can find without stuff that feels like hacks, and it's only a minor issue so I'm marking this as ready for review

@nobodywasishere nobodywasishere marked this pull request as ready for review July 26, 2024 07:29
@straight-shoota
Copy link
Member

I think a solution for linking backticks could be to inject PSEUDO_CLASS_PREFIX in expand_code_links. But we can do this in a follow-up.

@straight-shoota straight-shoota added this to the 1.14.0 milestone Aug 18, 2024
@straight-shoota straight-shoota changed the title Add pseudo-objects for NoReturn and Void Add documentation for NoReturn and Void Aug 19, 2024
@straight-shoota straight-shoota merged commit ee894e0 into crystal-lang:master Aug 19, 2024
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.

API docs for NoReturn and Void are missing

5 participants