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

Shal travis test (getting_started) example notebook(s)? #59

Open
fzeiser opened this issue Oct 10, 2019 · 1 comment
Open

Shal travis test (getting_started) example notebook(s)? #59

fzeiser opened this issue Oct 10, 2019 · 1 comment
Labels
help wanted Extra attention is needed
Milestone

Comments

@fzeiser
Copy link
Collaborator

fzeiser commented Oct 10, 2019

Should travis test the (getting_started) example notebook(s)? It'd be good to know that they always run, but due to the multinest normlization, they take a while to calculate.

@fzeiser fzeiser added the help wanted Extra attention is needed label Oct 10, 2019
@fzeiser
Copy link
Collaborator Author

fzeiser commented Oct 14, 2019

It might also be useful to run the notebook each time the documentation is build, see https://nbconvert.readthedocs.io/en/latest/execute_api.html.
I see some pros and cons: If we execute the notebook each time, it know that it runs. Nice. However, it might be that it creates unexpected results, and this is not automatically checked for. A new user would then try to follow the example notebook and assume that the results shown there are the correct results.

Probably there is an option to check that the metadata of the notebook did not change. Thus one is "forced" to run the example before uploading it and will be more likely to see/catch major changes.

@fzeiser fzeiser added this to the Version 1.0 milestone Jan 9, 2020
@fzeiser fzeiser modified the milestones: Version 1.0, Version 2.0 Mar 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant