Doc #81547 [Com]: print documentation section Documentation is contradictory

From: Date: Wed, 24 Apr 2024 09:15:59 +0000
Subject: Doc #81547 [Com]: print documentation section Documentation is contradictory
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-19705@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=81547&edit=1 ID: 81547 Comment by: dgme dot life at gmail dot com Reported by: ddpm at liscovius dot de Summary: print documentation section Documentation is contradictory Status: Open Type: Documentation Problem Package: Documentation problem PHP Version: Irrelevant Block user comment: N Private report: N New Comment: thanks (https://github.com/php/php-src/blob/php-8.1.0/NEWS)(https://www.dgme.run/) Previous Comments: ------------------------------------------------------------------------ [2024-04-23 12:45:28] dgme dot life at gmail dot com The blog was absolutely fantastic! Thank you for sharing this.It is worth reading for everyone. Very informative article. Keep it up. (https://github.com/php/php-src/blob/php-8.1.0/NEWS)(https://www.dgme.run/) ------------------------------------------------------------------------ [2023-04-20 08:56:22] simona at myaccountaccess dot onl Thanks for that. (https://www.myaccountaccess.onl/)github.com ------------------------------------------------------------------------ [2022-12-09 06:28:14] amin dot jadabari242 at gmail dot com Thanks for that. (https://www.myaccountaccess.one/)github.com ------------------------------------------------------------------------ [2021-11-03 13:08:37] 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> ------------------------------------------------------------------------ [2021-10-20 19:03:34] 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 ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=81547&edit=1

« previous php.doc.bugs (#19705) next »