php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #81547 print documentation section Documentation is contradictory
Submitted: 2021-10-20 19:03 UTC Modified: 2021-11-03 13:08 UTC
From: ddpm at liscovius dot de Assigned:
Status: Open Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
You can add a comment by following this link or if you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: ddpm at liscovius dot de
New email:
PHP Version: OS:

 

 [2021-10-20 19:03 UTC] ddpm at liscovius dot de 
Description:
------------
Synopsis on https://www.php.net/manual/en/function.print.php shows:

print(string $expression): int

But the description text says: 

"print is not a function but a language construct. Its argument is the expression following the print keyword, and is not delimited by parentheses."

I see that the problem lies in the way the documentation is built. How should the synopsis be for such **language construct**?

Expected result:
----------------
I do not know (yet).

Actual result:
--------------
print(string $expression): int

Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2021-11-03 13:08 UTC] cmb@php.net 
To my knowledge, DocBook has no special support for language
constructs (except maybe for EBNF, but that's a different story);
this is why our existing documentation for language constructs[1]
is suboptimal.  For print, and other language constructs which are
somewhat function-like, it makes probably still sense to document
these as functions.  If we want to get rid of the parentheses in
the synopses, this could be accomplished by adding some attribute
and to adapt PhD[2] accordingly.  However, it is not clear what to
do with the return values, and whether it's worth working on this
at all.

[1] <https://www.php.net/manual/en/language.control-structures.php>
[2] <https://github.com/php/phd>
 [2022-12-09 06:28 UTC] amin dot jadabari242 at gmail dot com 
Thanks for that. (https://www.myaccountaccess.one/)github.com
 [2023-04-20 08:56 UTC] simona at myaccountaccess dot onl 
Thanks for that. (https://www.myaccountaccess.onl/)github.com
 
PHP Copyright © 2001-2023 The PHP Group
All rights reserved. 		Last updated: Tue May 30 02:03:44 2023 UTC