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.

Sign up for GitHub

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

Jump to bottom

Implement consistent markdown handling for hovers & completions #12654

Merged
merged 3 commits into from Dec 10, 2023
Merged

Implement consistent markdown handling for hovers & completions #12654

merged 3 commits into from Dec 10, 2023

Conversation

anthony-c-martin
Copy link
Member

@anthony-c-martin anthony-c-martin commented Dec 8, 2023 •
edited

  • Embed descriptions as-is without modifications: current logic replaces \n with \n, which leads to rendering quirks.
  • Ensure we're emitting a double space + newline after every "block".
  • Move shared logic to MarkdownHelper class.

Closes #12412

Microsoft Reviewers: Open in CodeFlow

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 8, 2023 •
edited

Test this change out locally with the following install scripts (Action run 7157267994)

VSCode
  • Mac/Linux 
    bash <(curl -Ls https://aka.ms/bicep/nightly-vsix.sh) --run-id 7157267994
  • Windows 
    iex "& { $(irm https://aka.ms/bicep/nightly-vsix.ps1) } -RunId 7157267994"
Azure CLI
  • Mac/Linux 
    bash <(curl -Ls https://aka.ms/bicep/nightly-cli.sh) --run-id 7157267994
  • Windows 
    iex "& { $(irm https://aka.ms/bicep/nightly-cli.ps1) } -RunId 7157267994"

@anthony-c-martin anthony-c-martin mentioned this pull request Dec 8, 2023
Closed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 8, 2023 •
edited

Test Results

     132 files  ±0       132 suites  ±0   4h 9m 4s ⏱️ - 24m 56s
10 925 tests +2  10 925 ✔️ +2  0 💤 ±0  0 ❌ ±0 
52 623 runs  +8  52 623 ✔️ +8  0 💤 ±0  0 ❌ ±0 

Results for commit 6362dd4. ± Comparison against base commit 8727bc2.

♻️ This comment has been updated with latest results.

StephenWeatherford
StephenWeatherford reviewed Dec 8, 2023
View reviewed changes
src/Bicep.Core.Samples/Files/baselines/InvalidExpressions_LF/Completions/symbols.json Outdated
@@ -17,6 +21,10 @@
"label": "and",
"kind": "variable",
"detail": "and",
"documentation": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this causes no issues?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider: There would be a lot fewer changes if you didn't write this out for empty string.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, let me fix that.

@StephenWeatherford
Copy link
Contributor

image

You broke it! :-)

@anthony-c-martin anthony-c-martin enabled auto-merge (squash) December 10, 2023 10:34
@anthony-c-martin anthony-c-martin merged commit 8d03533 into main Dec 10, 2023
47 checks passed
@anthony-c-martin anthony-c-martin deleted the ant/issue12412 branch December 10, 2023 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StephenWeatherford StephenWeatherford StephenWeatherford approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

User Defined types - inconsistant visualization of tool tips
2 participants
@anthony-c-martin @StephenWeatherford