Improved scanner to only look at the "returnvalues" sections #305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…for their return values. New errors: * sys_getloadavg (defines falsy return in Description section, not Returnvalues) * posix_getpgid (idem) All other changes are fixes / improvements.
Syntactic error in DocPageTest (missing NEW instruction)
Codecov Report
@@ Coverage Diff @@
## master #305 +/- ##
============================================
+ Coverage 48.15% 48.67% +0.52%
- Complexity 306 308 +2
============================================
Files 16 16
Lines 785 795 +10
============================================
+ Hits 378 387 +9
- Misses 407 408 +1
Continue to review full report at Codecov.
|
Added the two new failures to special_cases for now; should ideally be fixed in php/docs-en repo.
Customized return hint on sys_getloadavg() in special_cases.
Kharhamel
approved these changes
Oct 17, 2021
dbrekelmans
approved these changes
Oct 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improved scanner to only look at the "returnvalues" sections of docs for their return values.
Previously, the entire docPage was scanned, leading to errors such as
password_hash(), where the string "returns false on failure" was found in the Changelog section.I have discovered two new errors resulting from this change:
sys_getloadavg()Is now missing (defines falsy return in Description section, instead of the Returnvalues section)posix_getpgid()idemThese functions have been added to the
special_cases, as the cause is an inconsistency in the PHP docs.All other removed functions have been checked, and are fixes / improvements to the generated function list.