Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs (tutorial): add context for referenced functions #19

Merged

Conversation

sadielbartholomew
Copy link
Member

(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 calling print() on, respectively, the field construct (or dataset, etc.).

To someone without relevant knowledge of Python to know that print() show the str() 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.

@sadielbartholomew sadielbartholomew changed the title Docs (tutorial): add context for referenced built-in functions Docs (tutorial): add context for referenced functions Nov 25, 2019
@davidhassell
Copy link
Collaborator

Thanks for these changes - they do make things clearer.

It's probably best to build the docs (when you fix the path problem ...) with something like make html dev, as any changes to the html created by running make html . will, if committed, appear in the latest docs at https://ncas-cms.github.io/cf-python/, which would then include documentation for features that are not in the latest release (3.0.5).

@davidhassell davidhassell merged commit 9cec030 into NCAS-CMS:master Nov 26, 2019
@sadielbartholomew sadielbartholomew deleted the docs-clarify-inspection branch January 11, 2020 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants