Skip to content

Fix generate docs for builtins HOST_TRIPLE and TARGET_TRIPLE#14570

Merged
straight-shoota merged 1 commit intocrystal-lang:masterfrom
straight-shoota:fix/docs-generator-target-const
May 9, 2024
Merged

Fix generate docs for builtins HOST_TRIPLE and TARGET_TRIPLE#14570
straight-shoota merged 1 commit intocrystal-lang:masterfrom
straight-shoota:fix/docs-generator-target-const

Conversation

@straight-shoota
Copy link
Member

When we originally added these constants in #13823 we overlooked that we also need to make the doc generator aware they are builtins which should be included in the doc output.
This is of course a bit brittle setup and we should try to find a better solution, but for now this patch fixes that these two constants show up in the API docs.

@straight-shoota straight-shoota added kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:tools:docs-generator labels May 6, 2024
@straight-shoota straight-shoota self-assigned this May 6, 2024
@crysbot
Copy link
Collaborator

crysbot commented May 6, 2024

This pull request has been mentioned on Crystal Forum. There might be relevant details there:

https://forum.crystal-lang.org/t/how-to-get-system-and-architecture/6819/2

@straight-shoota straight-shoota added this to the 1.13.0 milestone May 7, 2024
@straight-shoota straight-shoota merged commit 62a6944 into crystal-lang:master May 9, 2024
@straight-shoota straight-shoota deleted the fix/docs-generator-target-const branch May 9, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:tools:docs-generator

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants