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

Documentation in wrong place? #875

Open
cowwoc opened this issue Nov 22, 2024 · 1 comment
Open

Documentation in wrong place? #875

cowwoc opened this issue Nov 22, 2024 · 1 comment
Labels
area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec

Comments

@cowwoc
Copy link

cowwoc commented Nov 22, 2024

Describe what happened

Looking at droplet.d.ts, the gracefulShutdown property contains this sentence:

NOTE: If you use volumeIds on a Droplet, this provider will assume management over the full set volumes for the instance, and treat additional volumes as a drift. For this reason, volumeIds must not be mixed with external digitalocean.VolumeAttachment resources for a given instance.

This sounds like a typo. Shouldn't this sentence be attached to the volumeIds property documentation? It doesn't seem related to gracefulShutdown at all.

Sample program

N/A

Log output

No response

Affected Resource(s)

No response

Output of pulumi about

N/A

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

@cowwoc cowwoc added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Nov 22, 2024
@guineveresaenger guineveresaenger added area/docs Improvements or additions to documentation and removed needs-triage Needs attention from the triage team labels Nov 25, 2024
@guineveresaenger
Copy link
Contributor

Hi @cowwoc - thank you for filing this bug.

This is likely a docsgen bug in the pulumi-terraform bridge.

We'll investigate and move this issue to there if appropriate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Development

No branches or pull requests

2 participants