stray output in python doc

[ericrudder]

i noticed some extra characters while working on a sample.

note the /* strays in the https://pulumi.io/reference/pkg/python/pulumi_vsphere; according to @swgillespie, this is unique enough for a new issue.

[ellismg]

@justinvp Is this something you could take a look at?

[joeduffy]

Specifically, this appears to be https://www.pulumi.com/docs/reference/pkg/python/pulumi_vsphere/#pulumi_vsphere.ComputeCluster.ha_admission_control_resource_percentage_auto_compute.

[stack72]

So FYI, this is because there is an anchor link at the end of this (Look at the star!) https://www.terraform.io/docs/providers/vsphere/r/compute_cluster.html#ha_admission_control_resource_percentage_auto_compute

[praneetloke]

@stack72 ah good catch!

[praneetloke]

So it turns out that these "stray" \* aren't just some insignificant characters. Like @stack72 pointed out, these are anchor links in the backing TF provider doc. Specifically they link to this section, which indicates that the properties marked with * have a special vSphere version requirement. So I don't think we can just strip these. They have a significance. We don't have the version requirements section in our docs. I am thinking we could link these asterisk's to that section in TF's docs. I don't have a better idea.

cc @justinvp

[praneetloke]

Also, note that the version requirement is only for the vsphere_compute_cluster resource, which is this class in our Python docs. By the way, this is a problem in the NodeJS docs too. For example, https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/vsphere/#ComputeCluster-drsEnablePredictiveDrs.

[justinvp]

This does look like a more involved fix is required. While I'd love to fix this, I think some of the other fixes we want to do this milestone have broader impact, so I'd be OK with deferring this for a bit.

[praneetloke]

I have pushed this out to the next milestone for now.

[mjeffryes]

We strip these trailing '*' characters in docs now. That does mean that the footnote is not included, however, this footnote is actually irrelevant to the majority of the parameters where the upstream docs link to it, so I think this is strictly better.