php/doc-en

Document missing classes

Offen

#2.162 geöffnet am 10.01.2023

Auf GitHub ansehen
 (17 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)XML (882 Forks)auto 404
help wanted

Repository-Metriken

Stars
 (596 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 99T 23h) (90 gemergte PRs in 30 T)

Beschreibung

Currently, the following internal classes are not yet documented:

  • SensitiveParameterValue (#2165)
  • ClosedGeneratorException (#3065/#2997)
  • com_safearray_proxy (#3066)
  • DOMNameSpaceNode (#3060)
  • LibXMLError (#3063)
  • PDORow (#3059)
  • #3074
  • SQLite3Exception (#3079)

The following internal classes are going to be undocumented as soon as PHP 8.4 is released:

  • Dom\AdjacentPosition
  • Dom\DocumentType
  • Dom\CDATASection
  • Dom\Comment
  • Dom\ParentNode
  • Dom\ChildNode
  • Dom\Node
  • Dom\NameSpaceInfo
  • Dom\DocumentFragment
  • Dom\NodeList
  • Dom\CharacterData
  • Dom\Attr
  • Dom\Element
  • Dom\DOMException
  • Dom\Text
  • Dom\NamedNodeMap
  • Dom\Entity
  • Dom\EntityReference
  • Dom\Notation
  • Dom\ProcessingInstruction
  • Dom\XPath
  • Dom\Document
  • Dom\HTMLDocument
  • Dom\XMLDocument
  • ReflectionConstant

Contributor Guide

Research-Richtung
Identifiziere die nicht dokumentierten Klassen aus der Liste, die noch nicht abgehakt sind, recherchiere ihre PHP Implementierung und schreibe die Dokumentation gemäß dem PHP Dokumentations Styleguide. Überprüfe vorhandene Dokumentationsmuster für ähnliche Klassen.
Tech Stack
php
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPHP knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40