PHP 8.0 documentation tracker about doc-en HOT 35 CLOSED

Thank you everyone who participated in documentating the changes for 8.0!

from doc-en.

Trailing commas PR: #241

from doc-en.

If nobody has started on it yet, I'd like to help with documenting named arguments over the weekend. I think function arguments page would be a good candidate for this. Thoughts? cc @Girgias @cmb69

from doc-en.

@Girgias I'd like to help with adding the docs for a few of the new strig functions

The best way to do that is to fork https://github.com/php/doc-en/ and then to base the documentation on the strpos() function which is located here: https://github.com/php/doc-en/blob/master/reference/strings/functions/stripos.xml

from doc-en.

@Girgias Happy to hear this will be handled via a script and totally understand not adding it to the list in that case. Kudos to @kocsismate.

Just figured I'd mention it as I already ran into this - case in point: the example code in the Named Arguments RFC for array_fill() will no longer work as $num has been renamed to $count ;-)

from doc-en.

And thanks to cmb, there is already a tracker for the function signature updates in the manual: https://github.com/php/doc-en/labels/methodsynopses

from doc-en.

@50bhan I simply followed the instructions in the repo's README to understand set up and you can look at the review comments on my first PR to understand some of the things to watch out for.

#216

from doc-en.

There is a small tutorial for doc contributors. PRs to improve that tutorial are also welcome!

from doc-en.

Any suggestions for the preferred directory for the get_resource_id() and get_debug_type() documentation reference?

No worries, I've found the right directory. I'll add them to the var/functions directory 😬

from doc-en.

@Girgias I checked the ZipArchive's setProgressCallback() and setCancelCallback() and found out, that these two methods are in fact named registerProgressCallback() and registerCancelCallback(). Their documentation exists here and there.
So I created this PR #228 to update the migration guide

from doc-en.

@Girgias For the OCI8 renamed classes (OCI-Lob to OCILob & OCI-Collection to OCICollection) task the new PR is #246, replacing #237. With thanks to @cmb69.

from doc-en.

Here's the PR for named arguments and deprecation of optional args after mandatory ones: #251

from doc-en.

Also, we shouldn't forget about finishing the documentation of the function signature changes ( method synopsis )

from doc-en.

yet they may not be blockers for the PRs i mentioned which could close out the remaining checklist items and this issues remaining listed tasks.

Yeah, they are not a blocker in any way for the mentioned PRs: I just wanted to highlight that even if the tasks are done in this ticket, a bunch of PHP 8.0 related PRs are still waiting for review. :(

from doc-en.

It seems all tasks are done, issue can be closed? =)

from doc-en.

traits can now have abstract methods

That should say "abstract trait methods are validated against the implementation provided in the using class, according to our usual inheritance rules." and "traits can now have abstract private methods"

https://wiki.php.net/rfc/abstract_trait_method_validation

named params

named arguments - "Named arguments allow passing arguments to a function based on the parameter name, rather than the parameter position."

The php 8 migration docs in the linked pr seem to be correct

from doc-en.

traits can now have abstract methods

That should say "abstract trait methods are validated against the implementation provided in the using class, according to our usual inheritance rules." and "traits can now have abstract private methods"

https://wiki.php.net/rfc/abstract_trait_method_validation

named params

named arguments - "Named arguments allow passing arguments to a function based on the parameter name, rather than the parameter position."

The php 8 migration docs in the linked pr seem to be correct

This rather a tracker and not an accurate description of the features, but will modify them

from doc-en.

@Girgias I'd like to help with adding the docs for a few of the new strig functions

from doc-en.

@Girgias I'll take a shot at the $object::class docs.

from doc-en.

To add to the update list:

• Update the function signatures of all functions and methods where parameters have been renamed in anticipation of named parameters. (as otherwise people won't know what parameter names to use for PHP native functions)
• Where relevant, update the function signatures of all functions and methods where type declarations have been added or have been changed.
  In the case of changed: including adding a changelog entry to the function page.

from doc-en.

To add to the update list:

* [ ]  Update the function signatures of all functions and methods where parameters have been renamed in anticipation of named parameters. (as otherwise people won't know what parameter names to use for PHP native functions)

* [ ]  Where relevant, update the function signatures of all functions and methods where type declarations have been added or have been changed.
  In the case of _changed_: including adding a changelog entry to the function page.

This is already handled "internally" by us as @kocsismate is running a script to update the docs based on the official stubs and I'm confident he's tracking which extensions have already been covered.

My intent with this issue tracker is to track changes which don't need to be done in bulk, as those would be rather painful to do manually.

So I can add them, but I'm not sure it makes a lot of sense as I don't want someone to attempt to do this specific part.

from doc-en.

@Girgias I'd like to help with adding the docs for a few of the new strig functions

The best way to do that is to fork https://github.com/php/doc-en/ and then to base the documentation on the strpos() function which is located here: https://github.com/php/doc-en/blob/master/reference/strings/functions/stripos.xml

Thanks

from doc-en.

@Girgias opened PR for str_contains here: #216

from doc-en.

Is there any guidelines about how to write proper docs for PHP?

from doc-en.

Any suggestions for the preferred directory for the get_resource_id() and get_debug_type() documentation reference?

from doc-en.

If nobody has started on it yet, I'd like to help with documenting named arguments over the weekend. I think function arguments page would be a good candidate for this. Thoughts? cc @Girgias @cmb69

This would be the correct page, I wonder if at the same time you could do a paragraph about how Optional args after mandatory ones are deprecated as of PHP 8.0.0.

from doc-en.

@Girgias oh good one, will do! Thanks.

from doc-en.

ReflectionParameter::getType() is NOT deprecated!

ReflectionParameter::getClass(), ReflectionParameter::isArray(), and ReflectionParameter::isCallable() have been deprecated with the preferred method being getType()

unrelated: was ReflectionObject::export() removed in Php 8?

from doc-en.

Indeed fixed that

from doc-en.

I added some docs about the FILTER_VALIDATE_BOOL alias via #676

from doc-en.

Array sort functions are stable since PHP 8, but right now the info box indicates that they are unstable. Here's a pull request that clarifies that - #539

from doc-en.

I believe that when #1155 and #1025 are complete and merged in then all the PHP 8.0 docs are completed and we're all caught up here.

from doc-en.

@kocsismate i was mostly going off what items are in the top post as unchecked so far.
I do see the discussion about those being part of the 8.0 docs but not on the to-do. So it does seem that those should be merged - yet they may not be blockers for the PRs i mentioned which could close out the remaining checklist items and this issues remaining listed tasks.

from doc-en.

It seems all tasks are done, issue can be closed? =)

https://www.php.net/manual/en/reflectionproperty.construct.php
https://www.php.net/manual/en/reflectionproperty.getattributes.php
https://www.php.net/manual/en/reflectionproperty.clone.php
https://www.php.net/manual/en/reflectionproperty.getdeclaringclass.php
https://www.php.net/manual/en/reflectionproperty.getmodifiers.php
https://www.php.net/manual/en/reflectionproperty.getname.php
https://www.php.net/manual/en/reflectionproperty.tostring.php

These pages show message

"Warning
This function is currently not documented; only its argument list is available."

from doc-en.

It seems all tasks are done, issue can be closed? =)

https://www.php.net/manual/en/reflectionproperty.construct.php https://www.php.net/manual/en/reflectionproperty.getattributes.php https://www.php.net/manual/en/reflectionproperty.clone.php https://www.php.net/manual/en/reflectionproperty.getdeclaringclass.php https://www.php.net/manual/en/reflectionproperty.getmodifiers.php https://www.php.net/manual/en/reflectionproperty.getname.php https://www.php.net/manual/en/reflectionproperty.tostring.php

These pages show message

"Warning This function is currently not documented; only its argument list is available."

Please open a new issue, as this is not specific to changes introduced by PHP 8.0.

from doc-en.