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

Fix deprecation message rendering #3972

Closed
sean1588 opened this issue Feb 14, 2024 · 4 comments · Fixed by #3955
Closed

Fix deprecation message rendering #3972

sean1588 opened this issue Feb 14, 2024 · 4 comments · Fixed by #3955
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 resolution/fixed This issue was fixed
Milestone

Comments

@sean1588
Copy link
Member

I am 99% sure there is already an issue for this, but I cannot seem to track it down. Deprecation messages sometimes render strangely outside of its formatted box:

Screen Shot 2024-02-14 at 1 51 50 PM
@sean1588 sean1588 added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Feb 14, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Feb 14, 2024
@sean1588
Copy link
Member Author

sean1588 commented Feb 14, 2024

After doing a bit of investigation it looks like the trailing "\n" from the property description messes with the markdown rendering. After removing it the text appears correctly in the box, but we lose the description formatting. I'm looking into a solution here.

@sean1588 sean1588 added kind/bug Some behavior is incorrect or out of spec area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. and removed kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Feb 14, 2024
@sean1588 sean1588 removed this from Docs 📚 Feb 14, 2024
@sean1588 sean1588 self-assigned this Feb 14, 2024
@ericrudder
Copy link
Member

ericrudder commented Feb 14, 2024 via email

@sean1588
Copy link
Member Author

thank you @ericrudder, I'll take a look at that.

@sean1588 sean1588 added this to the 0.100 milestone Feb 16, 2024
@pulumi-bot pulumi-bot reopened this Feb 16, 2024
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have required labels: resolution/

Please fix these problems and try again.

@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Feb 16, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Feb 16, 2024
@sean1588 sean1588 added resolution/fixed This issue was fixed and removed needs-triage Needs attention from the triage team labels Feb 16, 2024
@github-project-automation github-project-automation bot moved this from 🤔 Triage to 🏁 Done in Docs 📚 Feb 16, 2024
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 resolution/fixed This issue was fixed
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants