phpDocumentor / phpDocumentor/phpDocumentor

Ensure that children of descriptors do not contain nulls

Open
#2,246 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Up-for-grabs
Dominant language
PHP
Stars
4.3k
Forks
648
Avg merge
28m
Merged PRs (30d)
13

Description

The effort to upgrade to PHPStan lvl6 uncovered that methods, properties, etc could contain null values: https://github.com/phpDocumentor/phpDocumentor/pull/2239#discussion_r373789176

At least, PHPStan thinks so.

This issue is about ensuring that this is not the case, or identifying why PHPStan reports this and submit a bug report with PHPStan.

Contributor guide

Open the contributing guide

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 PHPStan level 6 findings and the discussion linked from pull request 2239. Inspect how descriptor children such as methods and properties are populated, then determine whether null values can occur; done means preventing them or documenting a reproducible PHPStan report if the analysis is incorrect.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.