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.

Sign up for GitHub

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

Jump to bottom

Broken links in generated documentation #625

Closed
coryan opened this issue Jan 6, 2025 · 1 comment · Fixed by #691
Closed

Broken links in generated documentation #625

coryan opened this issue Jan 6, 2025 · 1 comment · Fixed by #691
Assignees
@coryan
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. sidekick Issues related to the code generator type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@coryan
Copy link
Contributor

coryan commented Jan 6, 2025

This link:

image

Sends you to this page:

https://docs.rs/gcp-sdk-secretmanager-v1/latest/gcp_sdk_secretmanager_v1/?search=SecretManagerService

We want this page:

https://docs.rs/gcp-sdk-secretmanager-v1/latest/gcp_sdk_secretmanager_v1/client/struct.SecretManagerService.html

I think the problem is the - vs. _ in rust documentation:

google-cloud-rust/src/generated/cloud/secretmanager/v1/README.md

Line 17 in 09db807

* [SecretManagerService](https://docs.rs/gcp-sdk-secretmanager-v1/latest/gcp-sdk-secretmanager-v1/client/struct.SecretManagerService.html)

We have the same problem in the top-level reference docs:

google-cloud-rust/src/generated/cloud/secretmanager/v1/src/lib.rs

Line 28 in 09db807

//! * [SecretManagerService](https://docs.rs/gcp-sdk-secretmanager-v1/latest/gcp-sdk-secretmanager-v1/client/struct.SecretManagerService.html)

@coryan coryan added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p3 Desirable enhancement or fix. May not be included in next release. sidekick Issues related to the code generator labels Jan 6, 2025
@coryan coryan self-assigned this Jan 14, 2025
@coryan coryan mentioned this issue Jan 17, 2025
Merged
@coryan
Copy link
Contributor Author

coryan commented Jan 17, 2025

Fixed in #691

@coryan coryan closed this as completed Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@coryan coryan

Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. sidekick Issues related to the code generator type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(generator): fix top-level links coryan/google-cloud-rust
1 participant
@coryan