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

nbexec behavior is different from the docs #13

Closed
ocefpaf opened this issue Jun 2, 2019 · 3 comments
Closed

nbexec behavior is different from the docs #13

ocefpaf opened this issue Jun 2, 2019 · 3 comments

Comments

@ocefpaf
Copy link

ocefpaf commented Jun 2, 2019

When using nbexec I get an output in the stdout but the docs mentioned I should get a suffixed file. Here is the docs text:

The nbexec command creates a copy of the input notebook, runs it from top to bottom and saves it. If an out_file name is not provided, the new filename will be the original filename with _executed.ipynb appended to it.

xref.: pyOpenSci/software-submission#7

@marskar
Copy link
Collaborator

marskar commented Jun 19, 2019

nbexec used to work like that, but I decided this was inconsistent with the other commands. I updated the docs to match the current code. Thanks for catching this!

@marskar marskar closed this as completed Jun 19, 2019
@kysolvik
Copy link

It looks like there still might be some leftovers in the docs from when the behavior was different. These lines in the readme make it sound like it'll create a output notebook by default.

"You can provide a more descriptive name for the executed output notebook..."

and

"You can preview the default output filename and the raw notebook output by running nbexec with only the positional argument:"

@marskar marskar reopened this Jul 16, 2019
@marskar
Copy link
Collaborator

marskar commented Jul 16, 2019

Hi @kysolvik,
You're right, I closed this issue to quickly! I made new changes with this commit dd2a5eb.
I think the docs are correct now.

@marskar marskar closed this as completed Jul 16, 2019
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

No branches or pull requests

3 participants