Skip to content

docs: improve WorkermanCompilerPass::referenceMap() PHPDoc#171

Merged
s2x merged 1 commit intocrazy-goat:masterfrom
tmchow:docs/146-improve-referencemap-phpdoc
Apr 16, 2026
Merged

docs: improve WorkermanCompilerPass::referenceMap() PHPDoc#171
s2x merged 1 commit intocrazy-goat:masterfrom
tmchow:docs/146-improve-referencemap-phpdoc

Conversation

@tmchow
Copy link
Copy Markdown
Contributor

@tmchow tmchow commented Apr 15, 2026

Closes #146.

Replaces the minimal @param string[] $taggedServices / @return Reference[] PHPDoc on WorkermanCompilerPass::referenceMap() with a description that names the method's purpose and tightens the types:

  • @param array<string, array<string, mixed>> $taggedServices matches the shape Symfony's ContainerBuilder::findTaggedServiceIds() returns (the actual callers pass its output in directly, see WorkermanCompilerPass::process()).
  • @return array<string, Reference> reflects that the map is keyed by service id, not a positional list.

No behaviour change.

Describe what the method does, tighten the @param type to the shape
returned by findTaggedServiceIds(), and annotate the returned map as
service id => Reference rather than a plain list.

Closes crazy-goat#146
@s2x s2x merged commit d1228f8 into crazy-goat:master Apr 16, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve WorkermanCompilerPass::referenceMap() documentation

2 participants