nteract/papermill

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

Open

#721 ouverte le 25 avr. 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (402 forks)batch import
bughelp wanted

Métriques du dépôt

Stars
 (5 381 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

🐛 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

Guide contributeur

Direction de recherche
Examinez la logique d'analyse des chaînes de documentation des paramètres dans la commande help notebook, en particulier la gestion des signes égal.
Stack technique
python
Domaine
cli
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75