|  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
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
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If this is not your bug, you can add a comment by following this link.
If this is your bug, but you forgot your password, you can retrieve your password here.
Bug Type:
From: ddpm at liscovius dot de
New email:
PHP Version: OS:


 [2021-10-20 19:03 UTC] ddpm at liscovius dot de
Synopsis on 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


Add a Patch

Pull Requests

Add a Pull Request


AllCommentsChangesGit/SVN commitsRelated reports
 [2021-11-03 13:08 UTC]
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] <>
[2] <>
 [2022-12-09 06:28 UTC] amin dot jadabari242 at gmail dot com
Thanks for that. (
 [2023-04-20 08:56 UTC] simona at myaccountaccess dot onl
Thanks for that. (
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Sat Apr 13 19:01:29 2024 UTC