[stdlib] Fix docstring examples in Dict.
#3688
Open
+17
−1
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
Signed-off-by: Max Brylski <[email protected]>
soraros
approved these changes
Oct 18, 2024
| from collections import Dict | ||
|
|
||
| var dict = Dict[String, Int]() | ||
| dict["a"] = 1 |
There was a problem hiding this comment.
Nit: Could you replace dict with d? dict causes incorrect syntax highlighting on GH. Maybe also remove `var.
There was a problem hiding this comment.
Highlighting looks fine for me.
Also, I try to avoid single letter names, would using my_dict work?
There was a problem hiding this comment.
dict will be blue because Python. my_dict works.
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.
Some general questions/notes about the topic of docstring examples:
Do we want the docstring examples to pass tests as a standalone thing,
Or, should we make them smaller and just ensure that they make sense in the context (for example, do we add imports, do we make sure that all variables are initialized, etc..)
Another thing (unrelated to Dict): Some examples don't pass when run with
mojo test, but they do work when copied into a main function (namely,io.mojo). I'm treating them as working.