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

Parameter docstring does not show in --help-notebook if it contains equal sign (=) #721

Open
ivsanro1 opened this issue Apr 25, 2023 · 0 comments · May be fixed by #813
Open

Parameter docstring does not show in --help-notebook if it contains equal sign (=) #721

ivsanro1 opened this issue Apr 25, 2023 · 0 comments · May be fixed by #813

Comments

@ivsanro1
Copy link

🐛 Bug

If I create a notebook with some parameter and a docstring to be shown by --help-notebook:

image

papermill --help-notebook example.ipynb 
Usage: papermill [OPTIONS] NOTEBOOK_PATH [OUTPUT_PATH]

Parameters inferred for notebook 'example.ipynb':
  alpha: float (default 0.5)      Alpha value
  n_jobs: int (default 1)         Number of workers to launch

But if the docstring of the parameter contains =, --help-notebook does not show it:

image

papermill --help-notebook example.ipynb 
Usage: papermill [OPTIONS] NOTEBOOK_PATH [OUTPUT_PATH]

Parameters inferred for notebook 'example.ipynb':
  alpha: float (default 0.5)      Alpha value

papermill version 2.4.0

@ivsanro1 ivsanro1 changed the title Parameter docstring does not show if it contains equal sign (=) Parameter docstring does not show in --help-notebook if it contains equal sign (=) Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant