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 the sphinx-design example #738

Merged
merged 1 commit into from
Mar 6, 2023

Conversation

recfab
Copy link
Contributor

@recfab recfab commented Mar 6, 2023

Under the ## Extending Sphinx heading, the text of the example discusses sphinx-design, but the pip install command was installing sphinxcontrib.mermaid. I see there is a commented-out example, below, which is related to mermaid, so perhaps this was missed in a copy/paste.

Under the `## Extending Sphinx` heading, the text of the example discusses `sphinx-design`, but the pip install command was installing `sphinxcontrib.mermaid`. I see there is a commented-out example, below, which is related to mermaid, so perhaps this missed in a copy/paste.
@welcome
Copy link

welcome bot commented Mar 6, 2023

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

@chrisjsewell
Copy link
Member

Yep cheers 🙏

When mermaid gets fixed, then it can come back out of the shadows lol (mgaitan/sphinxcontrib-mermaid#109)

@codecov
Copy link

codecov bot commented Mar 6, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (01c7565) 89.96% compared to head (c30c4eb) 89.96%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #738   +/-   ##
=======================================
  Coverage   89.96%   89.96%           
=======================================
  Files          23       23           
  Lines        2970     2970           
=======================================
  Hits         2672     2672           
  Misses        298      298           
Flag Coverage Δ
pytests 89.96% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@chrisjsewell chrisjsewell marked this pull request as ready for review March 6, 2023 04:12
@chrisjsewell chrisjsewell changed the title [DOC] Fix the sphinx-design example 📚 Fix the sphinx-design example Mar 6, 2023
@chrisjsewell chrisjsewell merged commit 2afac09 into executablebooks:master Mar 6, 2023
@welcome
Copy link

welcome bot commented Mar 6, 2023

Congrats on your first merged pull request in this project! 🎉
congrats

Thank you for contributing, we are very proud of you! ❤️

@recfab
Copy link
Contributor Author

recfab commented Mar 6, 2023

Oh! I just noticed that you merged it. Thanks!

Initially, I had created this PR in draft-mode currently so I could amend the commit message to conform to the guidelines listed at https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages. Is not that considered required in this case?

@recfab recfab deleted the patch-1 branch March 6, 2023 04:16
@chrisjsewell
Copy link
Member

Is not that considered required in this case?

no need for the formalities, I cahnaged the PR/commit message to have my emojis and thats all. Thanks for the contribution!

@recfab
Copy link
Contributor Author

recfab commented Mar 6, 2023

Glad to help. Thanks for the quick merge!

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

Successfully merging this pull request may close these issues.

2 participants