graphql-python / graphql-python/graphql-core-legacy

schema_printer should include descriptions

Offen
#217 1 Kommentar 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
372
Forks
175
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

`schema_printer.print_schema` produces a nice SDL, but it should also include the description strings, because "Documentation is first‐class feature of GraphQL type systems" ([from the spec](https://facebook.github.io/graphql/June2018/#sec-Descriptions)).

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne beim Einstiegspunkt schema_printer.print_schema und untersuche, wie das SDL zusammengesetzt wird. Vergleiche seine Ausgabe mit der Beschreibungssyntax der GraphQL-Spezifikation; abgeschlossen ist die Aufgabe, wenn Schema- und Typbeschreibungen im ausgegebenen SDL erscheinen und die bestehende Schemaausgabe weiterhin gültig bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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