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

Format enum deprecation messages #3983

Closed
sean1588 opened this issue Feb 16, 2024 · 0 comments · Fixed by pulumi/pulumi#15495
Closed

Format enum deprecation messages #3983

sean1588 opened this issue Feb 16, 2024 · 0 comments · Fixed by pulumi/pulumi#15495
Assignees
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/bug Some behavior is incorrect or out of spec kind/enhancement Improvements or new features resolution/fixed This issue was fixed size/S Estimated effort to complete (1-2 days).
Milestone

Comments

@sean1588
Copy link
Member

Now that enums are able to be rendered on the page, it's apparent we are not handling the deprecation message formatting the way we do for properties. We should match the formatting we use for deprecated properties.

Screen Shot 2024-02-16 at 1 20 10 PM
@sean1588 sean1588 added kind/enhancement Improvements or new features kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. labels Feb 16, 2024
@sean1588 sean1588 added this to the 0.101 milestone Feb 16, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Feb 16, 2024
@sean1588 sean1588 self-assigned this Feb 20, 2024
@sean1588 sean1588 removed the needs-triage Needs attention from the triage team label Feb 21, 2024
@sean1588 sean1588 removed this from Docs 📚 Feb 21, 2024
@sean1588 sean1588 added the size/S Estimated effort to complete (1-2 days). label Feb 21, 2024
github-merge-queue bot pushed a commit to pulumi/pulumi that referenced this issue Feb 27, 2024
fixes: pulumi/registry#3983

This PR fixes up some issues with our deprecation message formatting.
The deprecation messages attached to enums were not being formatted at
all, due to a missing css class. Secondly, I also noticed there was a
whitespace missing in the deprecation message when it renders in the
browser, due to the leading `-` in `{{- .... -}}`, so I addressed that
here as well.

### enum deprecation

before:
![Screen Shot 2024-02-22 at 10 20 34
AM](https://github.com/pulumi/pulumi/assets/16751381/89cf20b7-ad05-4085-9a42-fd73f964e250)



after:
![Screen Shot 2024-02-22 at 9 54 43
AM](https://github.com/pulumi/pulumi/assets/16751381/a95a8302-e40f-43aa-96a2-44f14b505571)

### fix whitespace after "Deprecated:"

before:
![Screen Shot 2024-02-22 at 10 20 53
AM](https://github.com/pulumi/pulumi/assets/16751381/53f088fa-5f46-45e4-b217-536b0affa0cf)

after:
![Screen Shot 2024-02-22 at 9 54 29
AM](https://github.com/pulumi/pulumi/assets/16751381/fbc687a7-43aa-4b80-9f3b-cd3d9f3255a0)
github-merge-queue bot pushed a commit to pulumi/pulumi that referenced this issue Feb 27, 2024
fixes: pulumi/registry#3983

This PR fixes up some issues with our deprecation message formatting.
The deprecation messages attached to enums were not being formatted at
all, due to a missing css class. Secondly, I also noticed there was a
whitespace missing in the deprecation message when it renders in the
browser, due to the leading `-` in `{{- .... -}}`, so I addressed that
here as well.

### enum deprecation

before:
![Screen Shot 2024-02-22 at 10 20 34
AM](https://github.com/pulumi/pulumi/assets/16751381/89cf20b7-ad05-4085-9a42-fd73f964e250)



after:
![Screen Shot 2024-02-22 at 9 54 43
AM](https://github.com/pulumi/pulumi/assets/16751381/a95a8302-e40f-43aa-96a2-44f14b505571)

### fix whitespace after "Deprecated:"

before:
![Screen Shot 2024-02-22 at 10 20 53
AM](https://github.com/pulumi/pulumi/assets/16751381/53f088fa-5f46-45e4-b217-536b0affa0cf)

after:
![Screen Shot 2024-02-22 at 9 54 29
AM](https://github.com/pulumi/pulumi/assets/16751381/fbc687a7-43aa-4b80-9f3b-cd3d9f3255a0)
@sean1588 sean1588 added the resolution/fixed This issue was fixed label Feb 27, 2024
github-merge-queue bot pushed a commit to pulumi/pulumi that referenced this issue Feb 27, 2024
fixes: pulumi/registry#3983

This PR fixes up some issues with our deprecation message formatting.
The deprecation messages attached to enums were not being formatted at
all, due to a missing css class. Secondly, I also noticed there was a
whitespace missing in the deprecation message when it renders in the
browser, due to the leading `-` in `{{- .... -}}`, so I addressed that
here as well.

### enum deprecation

before:
![Screen Shot 2024-02-22 at 10 20 34
AM](https://github.com/pulumi/pulumi/assets/16751381/89cf20b7-ad05-4085-9a42-fd73f964e250)



after:
![Screen Shot 2024-02-22 at 9 54 43
AM](https://github.com/pulumi/pulumi/assets/16751381/a95a8302-e40f-43aa-96a2-44f14b505571)

### fix whitespace after "Deprecated:"

before:
![Screen Shot 2024-02-22 at 10 20 53
AM](https://github.com/pulumi/pulumi/assets/16751381/53f088fa-5f46-45e4-b217-536b0affa0cf)

after:
![Screen Shot 2024-02-22 at 9 54 29
AM](https://github.com/pulumi/pulumi/assets/16751381/fbc687a7-43aa-4b80-9f3b-cd3d9f3255a0)
github-merge-queue bot pushed a commit to pulumi/pulumi that referenced this issue Feb 28, 2024
fixes: pulumi/registry#3983

This PR fixes up some issues with our deprecation message formatting.
The deprecation messages attached to enums were not being formatted at
all, due to a missing css class. Secondly, I also noticed there was a
whitespace missing in the deprecation message when it renders in the
browser, due to the leading `-` in `{{- .... -}}`, so I addressed that
here as well.

### enum deprecation

before:
![Screen Shot 2024-02-22 at 10 20 34
AM](https://github.com/pulumi/pulumi/assets/16751381/89cf20b7-ad05-4085-9a42-fd73f964e250)



after:
![Screen Shot 2024-02-22 at 9 54 43
AM](https://github.com/pulumi/pulumi/assets/16751381/a95a8302-e40f-43aa-96a2-44f14b505571)

### fix whitespace after "Deprecated:"

before:
![Screen Shot 2024-02-22 at 10 20 53
AM](https://github.com/pulumi/pulumi/assets/16751381/53f088fa-5f46-45e4-b217-536b0affa0cf)

after:
![Screen Shot 2024-02-22 at 9 54 29
AM](https://github.com/pulumi/pulumi/assets/16751381/fbc687a7-43aa-4b80-9f3b-cd3d9f3255a0)
github-merge-queue bot pushed a commit to pulumi/pulumi that referenced this issue Mar 2, 2024
fixes: pulumi/registry#3983

This PR fixes up some issues with our deprecation message formatting.
The deprecation messages attached to enums were not being formatted at
all, due to a missing css class. Secondly, I also noticed there was a
whitespace missing in the deprecation message when it renders in the
browser, due to the leading `-` in `{{- .... -}}`, so I addressed that
here as well.

### enum deprecation

before:
![Screen Shot 2024-02-22 at 10 20 34
AM](https://github.com/pulumi/pulumi/assets/16751381/89cf20b7-ad05-4085-9a42-fd73f964e250)



after:
![Screen Shot 2024-02-22 at 9 54 43
AM](https://github.com/pulumi/pulumi/assets/16751381/a95a8302-e40f-43aa-96a2-44f14b505571)

### fix whitespace after "Deprecated:"

before:
![Screen Shot 2024-02-22 at 10 20 53
AM](https://github.com/pulumi/pulumi/assets/16751381/53f088fa-5f46-45e4-b217-536b0affa0cf)

after:
![Screen Shot 2024-02-22 at 9 54 29
AM](https://github.com/pulumi/pulumi/assets/16751381/fbc687a7-43aa-4b80-9f3b-cd3d9f3255a0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/bug Some behavior is incorrect or out of spec kind/enhancement Improvements or new features resolution/fixed This issue was fixed size/S Estimated effort to complete (1-2 days).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant