feat(docs): add validation of xrefs to docfx command #6658
Merged
+255
−10
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
bshaffer
force-pushed
the
add-docs-ref-validation
branch
from
430f86b
to
7678de5
Compare
Hectorhammett
approved these changes
Jun 6, 2024
| foreach ($this->getInvalidXrefs($node->getContent()) as $invalidRef) { | ||
| if (isset(self::$allowedReferenceFailures[$node->getFullname()]) | ||
| && self::$allowedReferenceFailures[$node->getFullname()] == $invalidRef) { | ||
| // these links are inexplicably broken in phpdoc generation, and will require more investigation |
There was a problem hiding this comment.
Let's create a ticket for this one.
There was a problem hiding this comment.
It's a tricky situation because the issue (I think) is in phpdoc itself... but there's no indication AFAIK for why this would happen (they look identical to the other xrefs). It's absolutely baffling.
Before I can file an issue with phpdoc, I need to do more investigation to see if I can find out what could be causing it. Because I truly have no clue.
There was a problem hiding this comment.
Filed an issue in #7377
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.
Adds a
validatemethod to the docs generation, which throws an error when it encounters broken or invalidxrefreferences.The check will fail for any improperly formatted references, and if it can't find the class, it will fail for handwritten classes and GAPIC clients, but only output warnings for broken references in protobuf messages. This is because there are too many broken references in protobuf for us to even begin to fix them all. We will want to fix these in the protos themselves eventually (or at least file bugs for the API teams to fix them)
Also updates to the latest
phpdoc.