AnswerDotAI / AnswerDotAI/nbdev
keyword only '*' does not work with documentation
- Lingua principale
- Jupyter Notebook
- Stelle
- 5.3k
- Fork
- 513
- Merge medio
- 2g 30m
- PR unite (30g)
- 8
Descrizione
# Example
Hello! Using keyword only argument such as:
```python
#| export
def super_func(
keyword_or_non_keyword_arg, # this is a keyword or non-keyword arg
*,
keyword_only_arg # this is a keyword only arg
) -> str: # return string
"super func"
...
```
makes the documentation not working:
```python
show_doc(super_func)
```
```
super_func
super_func (keyword_or_non_keyword_arg, keyword_only_arg)
super func
| | Type | Details | | – | ——– | ———– | | keyword_or_non_keyword_arg | | this is a keyword or non-keyword arg | | keyword_only_arg | | | | Returns | str | return string |
```
the documentation for keyword_only_arg is absent
# Configuration
Python 3.7.16
nbdev 2.3.12
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia riproducendo il problema con l'esempio mostrato di Python 3.7.16 e show_doc(super_func) in nbdev 2.3.12, quindi mostra come viene rappresentato nella documentazione generata il parametro specificabile solo per nome; il lavoro è completato quando keyword_only_arg appare con la relativa documentazione e i dettagli esistenti dei parametri rimangono corretti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- jupyter, 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
- 45/100