Skip to content

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

@ivsanro1

Description

@ivsanro1

🐛 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

Activity

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 (`=`)[/+] on Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @ivsanro1

      Issue actions

        Parameter docstring does not show in `--help-notebook` if it contains equal sign (`=`) · Issue #721 · nteract/papermill