Task decorator removes docstring

Aperta
#971 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
python
Ambito
cli

Direzione di ricerca

Start in invoke/tasks.py around lines 353-358 and inspect how the @task decorator creates the Task object. Run the relevant existing tests for task decorators, then verify that a decorated function retains its docstring.

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

Descrizione

When using @task, the decorated function loses it's docstring, because internally a functools.wraps is missing here
https://github.com/pyinvoke/invoke/blob/edbb0b11b92452201c6516562140a20a2502a413/invoke/tasks.py#L353-L358

Easy to fix:

@wraps(body)
 def inner(body: Callable) -> Task[T]: 
     _task = klass(body, **kwargs) 
     return _task
Lingua principale
Python
Stelle
4.8k
Fork
412
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pyinvoke/invoke

Tutte le issue di pyinvoke/invoke

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.