Add phpdoc to MessageInterface::getHeaders(), consider not using null
Open
Nobody has claimed this yet.
type:docs
- Dominant language
- PHP
- Stars
- 44
- Forks
- 13
- Avg merge
- 54m
- Merged PRs (30d)
- 1
Description
Currently, MessageInterface::getHeaders() doesn't have phpdoc. We should add it.
Also, it may return null which means "do not add headers". An empty array could be possibly used for the same purpose. Need to consider it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with MessageInterface::getHeaders() and inspect its current contract and implementations. Add phpdoc describing the return value, then resolve whether null or an empty array represents no headers and ensure the documented behavior matches the interface.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100