Docs (tutorial): add context for referenced functions #19
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.
(As per #17, I will add a commit to build changes into the HTML files, once I can work out why I am getting errors trying to build the documentation.)
In the 'Inspection' section of the documentation tutorial there is reference to the built-ins
repr()
&str()
, but in the subsequent code examples those built-ins are not called directly, rather called under the hood by calling, & by callingprint()
on, respectively, the field construct (or dataset, etc.).To someone without relevant knowledge of Python to know that
print()
show thestr()
etc. I think it could be unclear as to how the code snippets & the functions referred to relate, so I suggest adding something similar to that proposed here to put that into context.