Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

why use different behavior for the description of query and mutation

Aperta
#1,325 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
graphql, python
Ambito
api, backend-api-design

Direzione di ricerca

Inizia confrontando la gestione della descrizione del campo query con il metodo di classe Field di graphene.mutation, che restituisce un graphene.Field usando description o cls._meta.description. Traccia il percorso con cui doc e le descrizioni di tipo o mutation arrivano nella documentazione generata. Il lavoro è completato quando i campi query e mutation seguono la stessa precedenza documentata e i test confermano le descrizioni risultanti.

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

Descrizione

🐛 bug

  • What is the current behavior?
    Now, the query description only use the description=... args for docs, the description or the doc in Typeclass only use for Type docs.
    but the mutation use the description args or the description of mutation class or the doc of mutation class for both mutation docs and mutation class docs.

  • What is the expected behavior?
    Both query and mutation should share the same logic for docs, first use the description arg of the field, then the description of meta class of class, the last is using doc of (the type or mutation) class.

  • Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow)
    dig into code, I find the graphene.mutation has a classmethod func named Field which return graphene.Field with description=description or cls._meta.description.

Lingua principale
Python
Stelle
8.2k
Fork
818
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 graphql-python/graphene

Tutte le issue di graphql-python/graphene

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.