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

Malformed code links in API docs #1756

Open
dandavison opened this issue Dec 15, 2024 · 0 comments
Open

Malformed code links in API docs #1756

dandavison opened this issue Dec 15, 2024 · 0 comments

Comments

@dandavison
Copy link
Contributor

There are various places in the API docs where the intention was to create a link, but the API docs renderer has not created a link. It looks like relevant documentation for creating links is at https://pkg.go.dev/github.com/fluhus/godoc-tricks#hdr-Documentation_Links-Links. We should do a pass replacing malformed links with correct links.

Examples:

https://pkg.go.dev/go.temporal.io/[email protected]/internal#UpdateWorkerVersioningRulesOptions

UpdateWorkerVersioningRulesOptions is the input to [Client.UpdateWorkerVersioningRules]

https://pkg.go.dev/go.temporal.io/[email protected]/client#UpdateWithStartWorkflowOptions

UpdateWorkerVersioningRulesOptions is the input to [Client.UpdateWorkerVersioningRules]

https://pkg.go.dev/go.temporal.io/[email protected]/internal#WithStartWorkflowOperation

WithStartWorkflowOperation defines how to start a workflow when using UpdateWithStartWorkflow. See [NewWithStartWorkflowOperation] and [UpdateWithStartWorkflow]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant