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.

Sign up for GitHub

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

Jump to bottom

Add hello world example and check to tests #215

Merged
merged 3 commits into from
Aug 26, 2018
Merged

Add hello world example and check to tests #215

merged 3 commits into from
Aug 26, 2018

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Aug 26, 2018 •
edited
Loading

Resolves #214

Checklist Before Requesting Approver

  • Tests are passing
  • "WIP" removed from the title of the pull request

@matthewfeickert
Add Hello World notebook
1281a4d
@matthewfeickert
Unpack runOnePoint output manually to support Python2
1775a61 
As Python2 doesn't have extended unpacking (c.f. PEP 3132) the unpacking
in the example needs to be changed to pass the CI
@matthewfeickert matthewfeickert added feat/enhancement New feature or request docs Documentation related labels Aug 26, 2018
@matthewfeickert matthewfeickert self-assigned this Aug 26, 2018
@matthewfeickert matthewfeickert changed the title Add hello world example and check to tests WIP: Add hello world example and check to tests Aug 26, 2018
@matthewfeickert matthewfeickert force-pushed the docs/add-hello-world-example-and-check branch from a590513 to 519f99e Compare August 26, 2018 01:23
@matthewfeickert
Add testing of Hello World example in README
09c04da 
This is done by explicitly calling doctest on the README in the docs
section of the CI. This is done instead of adding the README to
--doctest-glob in pytest.ini so as to keep the example in the README
displaying Python3 code.
@kratsg
Copy link
Contributor

kratsg commented Aug 26, 2018

Extended Upacking is a python 3 feature only. Just need to fix *_ and you're good, I think.

@coveralls
Copy link

coveralls commented Aug 26, 2018 •
edited
Loading

Coverage Status

Coverage remained the same at 97.228% when pulling 09c04da on docs/add-hello-world-example-and-check into e9d9f11 on master.

@matthewfeickert matthewfeickert force-pushed the docs/add-hello-world-example-and-check branch from 519f99e to 09c04da Compare August 26, 2018 01:28
@matthewfeickert
Copy link
Member Author

matthewfeickert commented Aug 26, 2018 •
edited
Loading

Extended Upacking is a python 3 feature only.

Yeah, that's exactly what I say in this commit.

However, I would prefer to not have Python2 code in the very first examples people see (for a few reasons) so I've just switched to explicitly calling doctest in the docs CI. Is that okay with people?

@matthewfeickert matthewfeickert changed the title WIP: Add hello world example and check to tests Add hello world example and check to tests Aug 26, 2018
@lukasheinrich
Copy link
Contributor

nice. thanks @matthewfeickert

@lukasheinrich lukasheinrich merged commit 2f5f094 into master Aug 26, 2018
@kratsg kratsg deleted the docs/add-hello-world-example-and-check branch August 26, 2018 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kratsg kratsg kratsg approved these changes

@lukasheinrich lukasheinrich Awaiting requested review from lukasheinrich

Assignees

@matthewfeickert matthewfeickert

Labels
docs Documentation related feat/enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@matthewfeickert @kratsg @coveralls @lukasheinrich