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: update docstring to prevent jsx closing tag error #3328

Merged

Conversation

brian-smith-tcril
Copy link
Contributor

Description

The latest run of "Build Docs" (https://github.com/openedx/paragon/actions/runs/12241372269/job/34146296486) led to a silent failure. I haven't investigated why the failure was silent yet but the error hiding in there was:

unknown: Expected corresponding JSX closing tag for <IconButtonToggle>. (7:35)

   5 |       {...props}
   6 |       components={components}>
>  7 | <p>{`Used with `}<IconButtonToggle></p>
     |                                    ^
   8 |     </MDXLayout>
   9 |   )
  10 | };undefined: unknown: Expected corresponding JSX closing tag for <IconButtonToggle>. (7:35)

   5 |       {...props}
   6 |       components={components}>
>  7 | <p>{`Used with `}<IconButtonToggle></p>
     |                                    ^
   8 |     </MDXLayout>
   9 |   )
  10 | };


  SyntaxError:unknown: Expected corresponding JSX closing tag for <IconButtonTo  ggle>. (7:35)
     5 |       {...props}
    6 |       components={components}>
  >  7 |<p>{`Us  ed with `}<IconButtonToggle><[0m  m/p>
      |^
    8 |</MDXLayout>
    9 |   )
   10 | };undefined: unknown: Expected corresponding JS  X closing tag for <IconButtonToggle>. (7:35)
     5 |       {...props}
    6 |       components={components}>
  >  7 |<p>{`Us  ed with `}<IconButtonToggle><[0m  m/p>
      |^
    8 |</MDXLayout>
    9 |   )
   10 | };

I was able to reproduce the error locally by running npm run build-docs, and verified the error was gone with this change.

Copy link

netlify bot commented Dec 9, 2024

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6afdae3
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/6757565c52c2c90008db3669
😎 Deploy Preview https://deploy-preview-3328--paragon-openedx.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.

@brian-smith-tcril
Copy link
Contributor Author

I created an issue for "Build Docs" failing silently #3329. I'll look into fixing that now.

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.42%. Comparing base (673ce70) to head (6afdae3).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3328   +/-   ##
=======================================
  Coverage   93.42%   93.42%           
=======================================
  Files         250      250           
  Lines        4515     4515           
  Branches     1017     1017           
=======================================
  Hits         4218     4218           
  Misses        294      294           
  Partials        3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

👍🏼

@brian-smith-tcril brian-smith-tcril merged commit 8215809 into openedx:master Dec 9, 2024
10 checks passed
@openedx-semantic-release-bot

🎉 This PR is included in version 22.11.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@bradenmacdonald
Copy link
Contributor

Whoops! Thanks for the quick fix, @brian-smith-tcril :)

@openedx-semantic-release-bot

🎉 This PR is included in version 23.0.0-alpha.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 22.11.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants