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

doclink: Incorrect "Exposed" requirement in method without context #1829

Open
antlai-temporal opened this issue Feb 18, 2025 · 0 comments
Open
Labels
bug Something isn't working

Comments

@antlai-temporal
Copy link
Contributor

Actual Behavior

	// WorkerDeploymentHandle is a handle to a Worker Deployment.
	// NOTE: Experimental
	//
	// Exposed as: [go.temporal.io/sdk/client.WorkerDeploymentHandle]
	WorkerDeploymentHandle interface {
        ...
        }
	// WorkerDeploymentClient is the client that manages Worker Deployments.
	// NOTE: Experimental
	//
	// Exposed as: [go.temporal.io/sdk/client.WorkerDeploymentClient]
	WorkerDeploymentClient interface {
		// GetHandle returns a handle to a Worker Deployment.
		//
		// This method does not validate the Worker Deployment Name. If there is no deployment
		// with that name in this namespace, methods like WorkerDeploymentHandle.Describe()
		// will return an error.
		// NOTE: Experimental
		//
		// Exposed as: [go.temporal.io/sdk/client.WorkerDeploymentHandle]    <----- WRONG, not needed, added by -fix
		GetHandle(name string) WorkerDeploymentHandle
       }

Missing doc in internal/worker_deployment_client.go for internal:WorkerDeploymentHandle to client:WorkerDeploymentHandle
2025/02/17 20:19:49 Changes needed, see previous stdout for which objects. Re-run command with -fix to auto-generate new docs.

Got above after running -fix

Expected Behavior

It should not add/require Exposed in GetHandle

See #1814

@antlai-temporal antlai-temporal added the bug Something isn't working label Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant