Ensure we stop looking for file phpdoc block asap #173
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #173 +/- ##
=========================================
Coverage 98.11% 98.11%
- Complexity 949 950 +1
=========================================
Files 40 40
Lines 2809 2811 +2
=========================================
+ Hits 2756 2758 +2
Misses 53 53 ☔ View full report in Codecov by Sentry. |
stronk7
force-pushed
the
shortcut_get_doc_from_open_tag_earlier
branch
2 times, most recently
from
41afe81 to
3126f19
Compare
Previously, we were allowing the getDocTagFromOpenTag() method to advance too much when looking for file phpdoc blocks. Now we stop as soon as any of the stop tokens is found. Note that this case is very edge one, only reproducible when there are lots of missing class/function phpdoc block, causing some other phpdoc block to be picked. In any case, I think that it's perfectly ok to shortcut the search that way, it can save us some precious iterations. Fixes moodlehq#172
stronk7
force-pushed
the
shortcut_get_doc_from_open_tag_earlier
branch
from
3126f19 to
13b8e00
Compare
|
Just amended a few comments and add a new case, via provider, to ensure all cases are covered. |
andrewnicols
approved these changes
Jul 1, 2024
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.
Previously, we were allowing the
getDocTagFromOpenTag()method to advance too much when looking for file phpdoc blocks. Now we stop as soon as any of the stop tokens is found.Note that this case is very edge one, only reproducible when there are lots of missing class/function phpdoc block, causing some other phpdoc block (type-hinting a variable or whatever) to be picked.
In any case, I think that it's perfectly ok to shortcut the search that way, it can save us some precious iterations.
Fixes #172