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

verify class references across the client libraries #6626

Closed
bshaffer opened this issue Sep 13, 2023 · 2 comments
Closed

verify class references across the client libraries #6626

bshaffer opened this issue Sep 13, 2023 · 2 comments

Comments

@bshaffer
Copy link
Contributor

See #6624

We had broken class references in our PHPDoc @see tags. We need to verify this does not exist in other components (namely, handwritten libraries). Some ways to potentially do this:

  • See if it's possible to check these using phpstan - this would be the most ideal place, if it's possible.
  • Verify these as part of our DocFX tests - as these are parsed by phpunit.xml, there should be a way to throw an error when @see fails to match a class.
  • As a last resort, verify manually by searching for @see references in the handwritten libraries.
@vishwarajanand
Copy link
Contributor

The PR provided here changes objects in a namespace {@see Google\Cloud\Storage\StorageObject} to {@see StorageObject}, but I think a better way to handle could have been {@see \Google\Cloud\Storage\StorageObject}, extra \ before Google. This way we can retain the full reference if a future tool needs it.

But its a full path vs relative path debate.

@yash30201
Copy link
Contributor

Fixed by #6647

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

3 participants