Add missing documentation for 'name' key in decoration definition #14761
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
wsor4035
added
@ Documentation
Trivial
aminothere
changed the title
aminothere
changed the title
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.
This PR makes no changes to running code, but adds missing documentation to lua_api.md.
This PR adds a description of the 'name' key in the decoration registration table definition.
The 'name' key in the decoration registration table is hardly documented, apart from a side mention in the list of global tables. An explicit description in the proper place makes its use in
minetest.get_decoration_idand subsequently the use ofminetest.set_gen_notifya little more clear.