mirror of https://github.com/pulumi/pulumi.git
6cfa4afcaf
<!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description Currently, our resource API docs for Python only display a type name itself. If the type is defined in a different module, we do not indicate this explicitly, which causes confusion. For example, [K8s Pod Inputs](https://www.pulumi.com/registry/packages/kubernetes/api-docs/core/v1/pod/#inputs) is in `core.v1` module itself but refer to the `meta.v1.ObjectMeta` type. Node.js docs display the type as <img width="719" alt="image" src="https://github.com/pulumi/pulumi/assets/1454008/fb3e8fc5-7dc8-4661-ac6f-95e7d7918cfc"> but Python simply shows <img width="725" alt="image" src="https://github.com/pulumi/pulumi/assets/1454008/4cd4c09c-13cb-4070-b716-0b78ad98379b"> The same problem exists when we reference types from external packages, and even for composed types like `Sequence[some_external_type]`. This PR removes a special case for Python that reduces a full type name to its name. Instead, it executes on the same path as Node.js and C#. I had to apply some cleaning to Python types to remove underscore prefixes of modules. We use underscore-prefixed imports in SDK gen, but they should not be visible in user docs. I expect we need to apply the same fix to Go, but I suggest we do that as a follow-up. Testing: the existing test suite seems adequate for testing the change. All the discrepancies look like improvements to me. Fixes #15137 ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> |
||
|---|---|---|
| .. | ||
| _index.md | ||