Edit report at https://bugs.php.net/bug.php?id=77348&edit=1
ID: 77348
User updated by: chealer at gmail dot com
Reported by: chealer at gmail dot com
-Summary: Misleading Edit button (edition not immediate)
+Summary: Misleading Edit button (edition not immediate and
conditional to application)
Status: Open
Type: Bug
Package: Online Doc Editor problem
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
Thank you cmb
In that case, I suppose there is an issue causing patch creators to get no notification when their
patch is rejected, and to have no way to understand the rejection even if they access Php Docbook
Online Editor again.
Previous Comments:
------------------------------------------------------------------------
[2019-01-02 13:59:31] cmb@php.net
> After, I completed each step to submit a patch against
> PDO::prepare(). I can now see that my changes are reflected in the
> actual documentation:
In practise, it is not really relevant whether a patch is listed
as work in progress, or whether it has been submitted as patch for
review. In both cases somebody with sufficient karma will have to
review the patch, and commit or reject it.
------------------------------------------------------------------------
[2019-01-02 06:13:55] chealer at gmail dot com
Thanks to much luck, just after reporting this I was pointed to a tutorial about using Php Docbook
Online Editor, which explains the step I must have been missing: https://www.youtube.com/watch?v=HLAuzZh2GVo
This tutorial is in French.
After, I completed each step to submit a patch against PDO::prepare(). I can now see that my changes
are reflected in the actual documentation:
http://svn.php.net/viewvc/phpdoc/en/trunk/reference/pdo/pdo/prepare.xml?r1=337261&r2=346459
This process still appears to be limited as the submitter's name and change description appear
to be lost, but given that it works and is quite straightforward, I apologize for describing the
tool as experimental. I would rather argue that offering a save button (with the floppy disk icon)
combined with the label "Edit" and without instructions when a contributor saves is likely
to mislead, but that's a much less severe issue.
I recommend to:
1. Relabel "Edit" to "Propose a change / Edit"
2. Make Php Docbook Online Editor's behavior or interface reflect that the edition process has
2 phases. This could be done by either warning each user on their first use, or by requiring users
to perform a "Start a patch" action before editing files, so they realize what they are
editing are temporary files only meant to generate a patch.
------------------------------------------------------------------------
[2018-12-27 14:10:00] cmb@php.net
Back to the issue at hand: the relevant line that would have to be
changed or removed is
<https://github.com/php/web-php/blob/bda2d837724d59efe8580b9232d6d60fa545cf5b/include/shared-manual.inc#L448>
------------------------------------------------------------------------
[2018-12-27 11:32:57] cmb@php.net
> The last proposal I made was in 2016, [â¦]
Ah, I see. Basically, I think the patch is fine, but I would use
âtemplateâ only when referring to the $statement parameter. See
the attached patch pdo-prepare.
> The question is where it shows.
I'm afraid, nowhere.
> [â¦] but there is something wrong in the system as a whole (the
> engine plus its operators) [â¦]
ACK. However, I don't think we should spend much time on
improving PhDOE, given that there are way more suitable
alternatives *almost* readily available, such as Github pull
requests. Personally, I even prefer to have a bug report with an
attached patch instead of a submission to PhDOE, unless it's about
a simple typo fix or such. While this is slightly more work, it
allows to discuss the patches and to track the progress.
------------------------------------------------------------------------
[2018-12-27 11:32:49] cmb@php.net
The following patch has been added/updated:
Patch Name: pdo-prepare
Revision: 1545910369
URL: https://bugs.php.net/patch-display.php?bug=77348&patch=pdo-prepare&revision=1545910369
------------------------------------------------------------------------
The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at
https://bugs.php.net/bug.php?id=77348
--
Edit this bug report at https://bugs.php.net/bug.php?id=77348&edit=1