Request Headers section in README seems misleading
Open
Nobody has claimed this yet.
bug?
- Dominant language
- Ruby
- Stars
- 10k
- Forks
- 1.2k
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 92
Description
Perhaps it is related to #1770.
So the README says that an example below will be normalized:
curl -H "secret_PassWord: swordfish" ...
But actually - it won't. If header name contains an underscore - in env it will remain as is and without HTTP_ prefix, and it won't appear in headers helper at all.
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 the Request Headers section in README and the curl example using "secret_PassWord: swordfish". Compare its normalization claim with the documented env behavior and headers helper, then update the README so the example and explanation match the actual handling of header names containing underscores.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100