Overhaul Dictionary Documentation #69594
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
Mickeon
commented
Dec 5, 2022
| if "Godot" in {"Godot": 4}: | ||
| print("The key is here!") # Will be printed. | ||
| [/codeblock] | ||
| [b]Note:[/b] This method returns [code]true[/code] as long as the [param key] exists, even if its corresponding value is [code]null[/code]. |
There was a problem hiding this comment.
This small note may or may not be mergeable with the very first sentence. Something along the lines of "Returns [code]true[/code] if the dictionary contains an entry with the given [param key], regardless of its corresponding value"
Mickeon
force-pushed
the
doc-peeves-read-a-dictionary
branch
2 times, most recently
from
38f7853 to
aebd72c
Compare
mhilbrunner
approved these changes
Dec 5, 2022
|
I should've left it as a draft as I also wanted to revamp the leading description. It's better to merge it ASAP though I suppose. |
raulsntos
requested changes
Dec 5, 2022
Mickeon
force-pushed
the
doc-peeves-read-a-dictionary
branch
2 times, most recently
from
bba2f73 to
3416281
Compare
|
Updated. Also added a small instruction on how to iterate a dictionary in the leading description, because if I didn't I would've later felt guilty about it. |
raulsntos
reviewed
Dec 5, 2022
Mickeon
force-pushed
the
doc-peeves-read-a-dictionary
branch
from
3416281 to
d68df24
Compare
|
Thank you very much for the feedback |
raulsntos
reviewed
Dec 5, 2022
Mickeon
force-pushed
the
doc-peeves-read-a-dictionary
branch
from
d68df24 to
b77f935
Compare
raulsntos
approved these changes
Dec 5, 2022
|
Thanks! |
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.
Continuation of especially #69451 and #68838...
Made the wording match how other classes are documented a lot more closely;
Made use of
[param]and several other strong references more often;Changed words where it felt necessary, where they could be mistaken for another concept of Godot's API, where technical terms are more appropriate. For example:
Modified examples extensively, with the main goal to improve readability and variety:
# Prints "5"-># Prints 5);COMPLETELY stripped away the part about Dictionary comparisons and hashes from the leading description.
Updated
Dictionary(from)constructor's description to be correct.Feedback is very, very welcome.