[sdk/python] Escape trailing underscore in docstring #14866
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The trailing underscore in this docstring needs to be escaped for it to render properly with Sphinx.
Changelog[uncommitted] (2023-12-18) |
Frassle
approved these changes
Dec 18, 2023
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 22, 2024
Waiting on #16441, but there are also a few other fixes in the queue that I'll opportunistically wait on as well. Tentative changelog: ### Features - [engine] Resolve provider in the engine before passing it to transforms [#16409](#16409) - [sdk/go] Suggest valid attributes with similar names to unrecognised ones when validating project definitions [#16097](#16097) - [cli/new] Allow passing runtime options as args in pulumi new [#16346](#16346) - [cli/new] Query language runtime for options during “pulumi new” [#16346](#16346) - [cli/new] Add packagemanager prompt to pulumi new for nodejs [#16417](#16417) - [sdk/nodejs] Detect pnpm workspaces when running pulumi install [#15525](#15525) - [sdk/nodejs] Add options to Workspace::removeStack() [#16333](#16333) - [sdk/python] Automatically convert requirements.txt to pyproject.toml when using Poetry [#16346](#16346) - [sdkgen/python] Generate TypedDict types for inputs [#15957](#15957) ### Bug Fixes - [engine] Fix a panic when ignoring wildcard values with arrays of different length [#16406](#16406) - [cli/engine] Fix --continue-on-error running indefinitely when a resource fails to be created or updated [#16371](#16371) - [sdk/nodejs] Avoid an unhandled error when `dependencies` is missing from `package.json` during closure serialization [#16433](#16433) - [cli/plugin] Fix plugin install command when plugin type is tool [#16407](#16407) - [sdk/python] Fix Python SDK docs by escaping the trailing underscore in a docstring [#14866](#14866) - [sdk/python] Don't incorrectly emit deprecation warnings for non-deprecated properties [#16400](#16400) - [sdk/python] Handle extra CLI arguments passed policy packs plugins [#16402](#16402) - [sdk/python] Add VIRTUAL_ENV environment variable when running inside a virtual environment [#16425](#16425) - [sdk/python] Don't lift dunder attributes on `Output`s ### Miscellaneous - [sdk/{go,nodejs,python}] Add register resource transform alias for register stack transform - [cli/new] Instruct the user to use 'pulumi install' when using --generate-only [#16411](#16411)
|
This PR has been shipped in release v3.121.0. |
This was referenced Jul 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The trailing underscore in this docstring needs to be escaped for it to render properly with Sphinx.
Currently, it's rendered as
importwithout the trailing underscore:It should be rendered as
import_:This change should fix that.
This is a follow-up from pulumi/pulumi-hugo#434