docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify in the docs if a property is static

Open xbnagy opened this issue 4 years ago • 4 comments

File: themes/default/content/docs/reference/pkg/azure-native/web/webapp.md

When "setting" the ManagedServiceIdentityType it is not clear from the documentation that you have to get it instead though ManagedServiceIdentityType.ServiceAssigned - as it is a static struct.

Consider updating the documentation to reflect that the property is read-only.

xbnagy avatar Jun 25 '21 10:06 xbnagy

Screen Shot 2021-06-26 at 8 15 50 AM

lukehoban avatar Jun 25 '21 22:06 lukehoban

@xbnagy Just to clarify, are you referring to the fact that https://www.pulumi.com/docs/reference/pkg/azure-native/web/webapp/#managedserviceidentitytype doesn't clarify that it's actually an enum and how to access the values of that enum depending on the language you're using?

leezen avatar Jun 25 '21 22:06 leezen

@leezen the clarification that's enum would be handy, as now only the compiler gives you that information. In the docs for other properties it's clear what's the expected input: string, boolean etc.

On how to access values given a user's programming language of choice is not required here (sorry if the example I put in the comment gave that impression)

xbnagy avatar Jun 30 '21 13:06 xbnagy

@xbnagy Great -- thanks for clarifying your feedback!

leezen avatar Jul 01 '21 00:07 leezen