AnswerDotAI / AnswerDotAI/nbdev

keyword only '*' does not work with documentation

Offen
#1,369 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
Jupyter Notebook
Sterne
5.3k
Forks
513
Ø Merge
2 T. 30 Min.
Gemergte PRs (30 T.)
8

Beschreibung

# 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
image

# Configuration

Python 3.7.16
nbdev 2.3.12

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, das Problem mit dem gezeigten Python-3.7.16-Beispiel und show_doc(super_func) in nbdev 2.3.12 zu reproduzieren, und zeige, wie der Parameter, der nur als Schlüsselwort verwendet werden kann, in der generierten Dokumentation dargestellt wird; abgeschlossen ist die Aufgabe, wenn keyword_only_arg mit seiner Dokumentation erscheint und die vorhandenen Parameterdetails weiterhin korrekt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter, python
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.