php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Request #71684 Version information for all manual pages
Submitted: 2016-02-28 17:44 UTC Modified: 2016-02-28 18:12 UTC
From: lsiden at gmail dot com Assigned:
Status: Open Package: Documentation problem
PHP Version: Irrelevant OS: all
Private report: No CVE-ID: None
 [2016-02-28 17:44 UTC] lsiden at gmail dot com
Description:
------------
---
From manual page: http://www.php.net/index
---

This is not a bug, but a suggestion: I would like to see every page of the manual contain a subtitle that states what version of PHP it applies to such as "(PHP4, PHP5, PHP7)".  This exists on many pages, such as those that document functions (e.g. https://secure.php.net/manual/en/function.assert.php), but not pages that apply to basic language features such as https://secure.php.net/manual/en/language.expressions.php.

It may be the practice of the authors that doc pages that cover basic language features like expressions apply to all versions and therefore do not need to state those versions, but I have found it confusing not to find this information on every doc page.

If the authors intend that a feature of the language and therefore its doc page should remain valid for all past and future versions and it might be cumbersome to have to change "(PHP4, PHP5, PHP7)" to "(PHP4, PHP5, PHP7, PHP8)" for example, then it might be sufficient to write "(all versions)".

If this is not the right forum to report this issue, please point me to the right one and I'll re-post it there.


Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2016-02-28 18:12 UTC] salathe@php.net
-Summary: Some pages of manual are missing version numbers +Summary: Version information for all manual pages -Type: Documentation Problem +Type: Feature/Change Request -Package: *General Issues +Package: Documentation problem
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Wed Dec 04 07:01:31 2024 UTC