Re: How to update docs
| From: | Chris Wright | Date: | Fri, 24 Apr 2015 20:22:56 +0000 |
| Subject: | Re: How to update docs | ||
| References: | 1 2 3 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385599@lists.php.net to get a copy of this message | ||
On 6:21PM, Fri, 24 Apr 2015 Ryan Pallas <derokorian@gmail.com> wrote:
>
> On Fri, Apr 24, 2015 at 10:14 AM, Peter Cowburn <petercowburn@gmail.com>
wrote:
>>
>> Hi Ryan,
>>
>> On 24 April 2015 at 16:25, Ryan Pallas <derokorian@gmail.com> wrote:
>>>
>>> Hi PHP Doc people,
>>>
>>> I was wondering if someone could help me to get an update to the manual
through? I've noticed today that the Class Constants page (
http://php.net/manual/en/language.oop5.constants.php)
doesn't make any
mention of the new Constant Expressions feature added in 5.6. And while it
is mentioned on the new features page for 5.6 (
http://php.net/manual/en/migration56.new-features.php)
I feels like the
pages affected by new features should also be updated.
>>>
>>> To me this is important to make sure dev looking up this information
have all the information. IE; someone new coming in to PHP want to look up
how class constants work, so they go to that page in the OOP section and
find that only scalar literals are allowed. But in fact, so are scalar
expressions in the newest version. They might never find this information
since its hidden away in the new features section of the docs. Or they
might not realize that being allowed to do it on global constants, means
they can do it on class constants (if they happen to go to that page as
well)
>>>
>>> As such, I've gone to edit.php.net (per the instructions I found) and
tried to edit the page. However it shows up in the All Files list in red,
and doesn't let me save changes to create a pull request. Am I missing
something obvious here? I don't see anything on the wiki about files being
in red.
>>
>> When the file is red, that's usually because someone else had edited the
file and the change hasn't been reviewed yet. If you open the file
(double-click, or right-click and choose edit), a little box should pop up
telling you the name of the user (or anonymous) that has modified the file.
>>
>> That indeed was the case for the file you are looking to edit, so I have
reviewed the change that was blocking you from editing the file. The file
should be available for editing now.
>
> Thanks Peter! I've made the change, and I'll go through some changelogs
and make sure the changes are on relevant pages this weekend. I've
submitted the patch set for this file in the mean time.
(You may have already done this, I can't easily log into the editor to
check at the moment but it's a common mistake)
Make sure you have gone through the process of "submit as patch"... we
often get people clicking the save button but not doing this last step,
leaving the file as WIP. This is the most common cause of the issue you
initially ran into.
If you are unsure of anything feel free to come back with any queries :-)
>
>
>>
>>>
>>>
>>> Thanks for you time,
>>>
>>> -Ryan
>>
>> Cheers,
>>
>> Peter
>
>
> -Ryan