AnswerDotAI / AnswerDotAI/nbdev

Function def input parameter comments causing a "Javascript error"

Aperta
#1,353 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
bug
Lingua principale
Jupyter Notebook
Stelle
5.3k
Fork
513
Merge medio
2g 30m
PR unite (30g)
8

Descrizione

With the following in a code cell:
```
#| export
def XCORS_trim_to_time(
f:str,
start:str,
stop:str):
pass
```

and this in a following cell:
```
show_doc(XCORS_trim_to_time)
```

I get the correct expected output:
![image](https://github.com/fastai/nbdev/assets/6384461/1b5c1429-baa0-4e0a-8d38-d012b4d4168d)

But when inserting parameter comments as described in the
Nbdev video:

```
#| export
def XCORS_trim_to_time(
f:str, # Filename
start:str, # Start time.
stop:str): # Stop time.
pass
```

```
show_doc(XCORS_trim_to_time)
```

Below is a screencap of the resulting fail:
![image](https://github.com/fastai/nbdev/assets/6384461/56c499b4-a1b8-485d-89fe-b321957355c8)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Riproduci il problema in un notebook usando la definizione esportata di XCORS_trim_to_time con commenti inline sui parametri, quindi esegui show_doc(XCORS_trim_to_time) nella cella seguente. Confronta l’output con la versione senza commenti; il lavoro è completato quando i commenti dei parametri non causano più un errore JavaScript e la documentazione viene visualizzata correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter-notebook, python
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.