Fix docs 404 for XrAnchorCreateCallback #5880
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mvaligursky
approved these changes
Dec 5, 2023
|
LGTM! |
|
Thanks @kungfooman ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Little oversight of @Maksims, currently we have a 404 in the docs:
https://developer.playcanvas.com/en/api/pc.XrAnchors.html#create
What makes it a bit worse ... the HTTP redirection goes into an endless loop:
https://developer.playcanvas.com/en/en/en/en/en/en/en/en/en/en/en/en/en/en/en/en/en/en/en/en/api/pc.XrAnchorCreate.html
The reason is pretty much that internally a callback is defined as a typedef, but instead of having properties, callbacks have params. So in order to differentiate between the two, the
name.endsWith('Callback')logic was introduced. We could change that logic of course and check for "does the typedef has params?", but I personally like the Callback ending (since the ending makes it immediately clear what it is).I confirm I have read the contributing guidelines and signed the Contributor License Agreement.