php / php/doc-en

Document missing classes

Open
#2,162 17 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the unchecked Dom\Node, Dom\DocumentFragment, Dom\NodeList, Dom\Element, Dom\NamedNodeMap, Dom\ProcessingInstruction, Dom\XPath, Dom\Document, Dom\HTMLDocument, and Dom\XMLDocument entries in the issue. Done means each listed internal class has documentation before PHP 8.4 makes it undocumented.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.