Missing documentation for `init_with` and `encode_with`?

Offen
#465 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
38/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
documentation

Rechercherichtung

Beginne damit, die zentrale Psych-Dokumentation und vorhandene Verweise auf init_with und encode_with zu finden. Dokumentiere, wie benutzerdefinierte Klassen diese Methoden für Serialisierung und Deserialisierung verwenden, und überprüfe anschließend, dass beide Methoden in der zentralen Dokumentation klar abgedeckt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Documentation

Looks like the main documentation is missing doc on how to (de)serialize custom classes by implementing init_with and encode_with.

Maybe @BurdetteLamar could help?

Vorherrschende Sprache
Ruby
Sterne
596
Forks
223
Ø Merge
8 Std. 38 Min.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/psych

Alle Issues in ruby/psych

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

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