Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix section order issues for all files #658

Closed
Girgias opened this issue Jun 4, 2021 · 5 comments
Closed

Fix section order issues for all files #658

Girgias opened this issue Jun 4, 2021 · 5 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed QA Quality Assurance

Comments

@Girgias
Copy link
Member

Girgias commented Jun 4, 2021

These issues can be found by using the section-order.php QA script located in doc-base,
and should be fixed similarly to how it is done in #657

@Girgias Girgias added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 4, 2021
@mumumu
Copy link
Member

mumumu commented Jun 6, 2021

php doc-base/scripts/qa/section-order.php | awk '{print $2}'| awk -F '/' '{print $8}'|sort | uniq -c | awk '{print "  - [ ] " $2 " ("$1 ")"}' | tail -n +2

Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
preg_filter() parameters still need to be documented.

Part of php#658
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
Girgias added a commit to Girgias/doc-en that referenced this issue Jun 6, 2021
@Girgias
Copy link
Member Author

Girgias commented Jun 6, 2021

I went through a couple of them and most of them where straight forward, couple of issues I found:

  • ev is a false positive, but I don't understand why it gets picked up by the script (ignore this I thought it was flaging the return section)
  • preg_filter() is missing documentation for its parameters (which is surprising, and a doc bug)
  • Same for MemCached::setOption()
  • SoapClient::__call() the docs mention this is deprecated, but it is not in php-src, and it's missing both docs for its params and return value.
  • The MongoDB seem to be all false positive, the bson and tutorial folder needs to be excluded in the script
  • runkit7_zval_inspect() needs to have it's array return value explained.
  • Similarly, eio_fchown() needs its non void return value explained.

Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
Girgias added a commit that referenced this issue Jun 6, 2021
preg_filter() parameters still need to be documented.

Part of #658
Girgias added a commit that referenced this issue Jun 6, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 10, 2021
saundefined added a commit that referenced this issue Jun 11, 2021
saundefined added a commit that referenced this issue Jun 11, 2021
saundefined added a commit that referenced this issue Jun 11, 2021
@Girgias
Copy link
Member Author

Girgias commented Jun 12, 2021

I've updated the script, it clear a bunch of false positives, but I've also added detection for predefined classes and for "unknown" section roles (some of them might make sense in which case the script will need to be revised again).

mumumu added a commit that referenced this issue Jun 13, 2021
mumumu added a commit that referenced this issue Jun 13, 2021
mumumu added a commit that referenced this issue Jun 13, 2021
Part of #658
constants section is moved to returnvalues one.
saundefined added a commit that referenced this issue Jun 13, 2021
saundefined added a commit that referenced this issue Jun 13, 2021
saundefined added a commit that referenced this issue Jun 13, 2021
saundefined added a commit that referenced this issue Jun 13, 2021
saundefined added a commit that referenced this issue Jun 13, 2021
Girgias added a commit that referenced this issue Jun 13, 2021
Also rearange changelog before examples for one file

Part of #658
Girgias added a commit that referenced this issue Jun 13, 2021
saundefined added a commit that referenced this issue Jul 2, 2021
saundefined added a commit that referenced this issue Aug 12, 2021
@Girgias Girgias added the QA Quality Assurance label Mar 16, 2022
@saundefined
Copy link
Member

Seems it can be closed =)

@Girgias
Copy link
Member Author

Girgias commented May 12, 2022

All items have been addressed.

@Girgias Girgias closed this as completed May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed QA Quality Assurance
Projects
None yet
Development

No branches or pull requests

3 participants