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

docs: investigate failing references #7377

Open
bshaffer opened this issue Jun 6, 2024 · 0 comments
Open

docs: investigate failing references #7377

bshaffer opened this issue Jun 6, 2024 · 0 comments

Comments

@bshaffer
Copy link
Contributor

bshaffer commented Jun 6, 2024

See our DocFX reference validation - we have two references failing for no clear reason:

private static array $allowedReferenceFailures = [
'\Google\Cloud\ResourceManager\V3\Client\ProjectsClient::testIamPermissions()'
=> 'ProjectsClient::testIamPermissionsAsync()',
'\Google\Cloud\Logging\V2\Client\ConfigServiceV2Client::getView()'
=> 'ConfigServiceV2Client::getViewAsync()'
];

These look exactly like all our other references (AFAIK), but PHPDocumentor renders their Xrefs as empty.

I believe this is an issue in phpdoc, but without further investigation, it's hard to say for sure (or even to file a useful ticket for them to fix). We should investigate this in order to fix the reference and remove the exceptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant