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

Links to source code of methods on protobuf types are broken #1423

Closed
beccasaurus opened this issue Apr 13, 2017 · 4 comments
Closed

Links to source code of methods on protobuf types are broken #1423

beccasaurus opened this issue Apr 13, 2017 · 4 comments
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@beccasaurus
Copy link

Example: docs for Google::Monitoring::V3::TimeInterval

screen shot 2017-04-13 at 1 35 56 am

^--- Source Code link broken

Broken link: https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/google-cloud/master/google-cloud-monitoring/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb#L49

Or all of the Source Code links on google/api types like: Google::Api::Metric or common types like Google::Protobuf::Timestamp

@blowmage
Copy link
Contributor

Unfortunately, all those links will be to the dummy documentation files, and not show any code, because so much of these GAPIC methods are created at runtime.

@quartzmo
Copy link
Member

This behavior is unfortunately present for all types' source links (not just GAPIC) in the google-cloud meta-package docs.

In google-cloud's Google::Cloud::Bigquery::Project, all source code links return 404, since they link to a path (google-cloud-ruby/blob/google-cloud/master/google-cloud-bigquery/) that does not exist in the meta-package's source directory.

In google-cloud-bigquery's Google::Cloud::Bigquery::Project, the source code links work correctly.

There is probably a one-off workaround for this, but it is yet another example of the difficulty of implementing meta-package docs as copies of member package docs, rather than as simply references to member package docs.

@quartzmo quartzmo removed the gapic label Apr 20, 2017
@geigerj geigerj added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Aug 7, 2017
@quartzmo quartzmo added type: cleanup An internal cleanup or hygiene concern. and removed type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Dec 4, 2017
@quartzmo
Copy link
Member

quartzmo commented Mar 7, 2018

Moved to the public planning wiki due to the delay in implementing the new documentation site.

@quartzmo quartzmo closed this as completed Mar 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

4 participants