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

fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 #9727

Merged
merged 5 commits into from
Jan 12, 2024
Merged

fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 #9727

merged 5 commits into from
Jan 12, 2024

Conversation

tats-u
Copy link
Contributor

@tats-u tats-u commented Jan 11, 2024 •
edited
Loading

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

The following code in VB.NET and VB.NET code in Dogfooding test cases is not valid due to the magick comment:

Dim array = {
  1,
  2,
  ' highlight-next-line
  3 ' Don't add the trailing comma here!
}

We have to use _ ' there instead but it has not been supported in Docusaurus yet.

Dim array = {
  1,
  2,
  _ ' highlight-next-line
  3 ' Don't add the trailing comma here!
}

This _ ' is supported only in Visual Studio 2019 or later (VB 16.x). There is no way to add comments in the middle of statements in older VB including Excel VBA.

I believe that this can be safely merged in v3.1.1. (minor language & does not break existing code blocks)

Also, VB.NET code in Dogfooding test has the wrong name for set. Set is wrong and must be HashSet instead.

Test Plan

Dogfooding

Test links

Deploy preview: https://deploy-preview-9727--docusaurus-2.netlify.app/tests/pages/code-block-tests#magic-comments-tests

Related issues/PRs

#9671

@tats-u tats-u requested a review from slorber as a code owner January 11, 2024 09:26
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 11, 2024
@tats-u tats-u changed the title feat(theme-common): fix missing code block MagicComments style in Vis… feat(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16.x Jan 11, 2024
@tats-u tats-u marked this pull request as draft January 11, 2024 09:26
@netlify Netlify
Copy link

netlify bot commented Jan 11, 2024 •
edited
Loading

✅ [V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 4bb3c19
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/659ffd0b2f5a9b0008ef8d0f
😎 Deploy Preview https://deploy-preview-9727--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 11, 2024 •
edited
Loading

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 67 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 66 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 76 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 70 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 64 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 74 🟢 100 🟢 100 🟢 90 🟠 89 Report

@tats-u tats-u marked this pull request as ready for review January 11, 2024 14:41
@tats-u tats-u changed the title feat(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16.x feat(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 Jan 11, 2024
@slorber slorber changed the title feat(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 Jan 12, 2024
@slorber slorber added pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 12, 2024
@slorber
Copy link
Collaborator

slorber commented Jan 12, 2024

Thanks

Let's consider it as a follow-up fix of #9671

@slorber slorber merged commit d75f99f into facebook:main Jan 12, 2024
32 checks passed
@tats-u tats-u deleted the vbnet-comment branch January 13, 2024 04:44
@tats-u
Copy link
Contributor Author

tats-u commented Jan 14, 2024

Thank you for approving the merge into 3.1.1.

slorber pushed a commit that referenced this pull request Jan 26, 2024
@tats-u @slorber
fix(theme-common): fix missing code block MagicComments style in Visu…
f55aad1 
…al Basic (.NET) 16 (#9727)
slorber added a commit that referenced this pull request Jan 26, 2024
@slorber @Josh-Cena
@reece-white @Shreesh09 @NickGerleman @harryzcy @mcrstudio @heysokam @c0h1b4 @jgarrow @OzakIOne @axmmisaka @tats-u @SimenB @sanjaiyan-dev @jack-robson @dawei-wang @eitsupi
chore: release Docusaurus 3.1.1 (#9793)
72dcd0d 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Joey Clover <joey@popos.local>
Co-authored-by: reece-white <93522192+reece-white@users.noreply.github.com>
Co-authored-by: Shreesh Nautiyal <114166000+Shreesh09@users.noreply.github.com>
Co-authored-by: Nick Gerleman <nick@nickgerleman.com>
Co-authored-by: Chongyi Zheng <git@zcy.dev>
Co-authored-by: MCR Studio <99176216+mcrstudio@users.noreply.github.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Ivan Mar (sOkam!) <7308253+heysokam@users.noreply.github.com>
Co-authored-by: c0h1b4 <dwidman@gmail.com>
Co-authored-by: Janessa Garrow <janessa.garrow@gmail.com>
Co-authored-by: ozaki <29860391+OzakIOne@users.noreply.github.com>
Co-authored-by: axmmisaka <6500159+axmmisaka@users.noreply.github.com>
Co-authored-by: Tatsunori Uchino <tats.u@live.jp>
Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>
Co-authored-by: Sanjaiyan Parthipan <parthipankalayini@gmail.com>
Co-authored-by: Jack Robson <143492403+jack-robson@users.noreply.github.com>
Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com>
Co-authored-by: eitsupi <50911393+eitsupi@users.noreply.github.com>
fix(create-docusaurus): fix readme docusaurus 2 ref (#9487)
fix(theme): fix firefox CSS :has() support bug (#9530)
fix(theme): docs html sidebar items should always be visible (#9531)
fix: v3 admonitions should support v2 title syntax for nested admonitions (#9535)
fix(theme-classic): fixed wrong cursor on dropdown menu in navbar, when window is small (#9398)
fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (#9567)
fix: add v2 retrocompatible support for quoted admonitions (#9570)
fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (#9477)
fix(content-blog): add baseUrl for author.image_url (#9581)
fix(type-aliases): add `title` prop for imported inline SVG React components (#9612)
fix(utils): Markdown link replacement with <> but no spaces (#9617)
fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (#9631)
fix(cli): output help when no conventional config + no subcommand (#9648)
fix CI job (#9604)
fix Lint Autofix workflow (#9632)
fix(pwa-plugin): upgrade workbox (#9668)
fix(create-docusaurus): fix init template code blocks, and little improvements (#9696)
fix(theme): allow empty code blocks and live playgrounds (#9704)
fix(core): various broken anchor link fixes (#9732)
fix: remove old useless mdx typedefs (#9733)
fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (#9727)
fix(core): conditionally include `hostname` parameter when using… (#9407)
fix(create-docusaurus): fix typo in init template sample docs (#9783)
fix(mdx-loader): allow spaces before `mdx-code-block` info string (#9776)
fix(core): links with target "_blank" should no be checked by the broken link checker (#9788)
fix(core): broken links optimization behaves differently than non-optimized logic (#9791)
This was referenced May 19, 2024
Open
Open
@Abuchtela Abuchtela mentioned this pull request May 20, 2024
Closed
@gabber235 gabber235 mentioned this pull request May 24, 2024
Closed
This was referenced May 25, 2024
Merged
Open
Open
@qdraw qdraw mentioned this pull request May 26, 2024
Closed
@qdraw qdraw mentioned this pull request Jun 22, 2024
Merged
@kaelynj kaelynj mentioned this pull request Jun 23, 2024
Closed
This was referenced Jun 27, 2024
Open
Open
@WontonSam WontonSam mentioned this pull request Jul 16, 2024
Open
This was referenced Jul 17, 2024
Open
Open
Open
Open
This was referenced Jul 21, 2024
Closed
Closed
This was referenced Jul 21, 2024
Open
Open
Open
This was referenced Aug 4, 2024
Merged
Closed
@Abuchtela Abuchtela mentioned this pull request Aug 11, 2024
Closed
This was referenced Aug 12, 2024
Closed
Closed
This was referenced Aug 15, 2024
Open
Open
Open
This was referenced Aug 21, 2024
Open
Open
This was referenced Aug 27, 2024
Open
Open
Open
Open
Open
@Ramyromel Ramyromel mentioned this pull request Aug 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slorber slorber Awaiting requested review from slorber slorber is a code owner

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tats-u @slorber @facebook-github-bot