php / php/doc-en

Note on page for header() needs clarification.

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

Nobody has claimed this yet.

Extension: standard good first issue QA Status: Verified
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

On the manual page for header(), in the Notes section, the second note starts "You can use output buffering to get around this problem, ...".

What is "this problem"? The Wayback machine says it it refers to the paragraph right back up in the Description section about headers having to be sent before output is generated (the note was relocated during a redesign of the manual in 2007 without being edited).

Also, calling it a "problem" might be inaccurate. If it becomes a problem, then there are measures you can take to work around it, but by itself it's just an assertion that headers must precede the body.

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

Open the manual page for header() and compare the second note in the Notes section with the earlier paragraph in the Description section about headers preceding output. Clarify what “this problem” refers to and revise the wording so it describes the condition accurately; the issue is done when the note is unambiguous and no longer calls the requirement itself a problem.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.