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 five alt image text references erroneously interpreted as substitution directives in sphinx build #180

Merged
merged 1 commit into from
Jun 17, 2022

Conversation

speediedan
Copy link
Contributor

The notebook update PR on the main repo currently has the build-docs job failing due to sphinx interpreting some alternate image text with an underscore as a substitution. This PR simply replaces underscores in those five alt image text references with hyphens to allow the build-docs workflow to proceed without error.

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

What does this PR do?

This PR is a small doc fix replacing 5 alt image text strings that had underscores with hyphens to prevent them from being interpreted as substitution directives

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Jun 14, 2022

Codecov Report

Merging #180 (5c6023b) into main (dcf7793) will not change coverage.
The diff coverage is n/a.

@@         Coverage Diff         @@
##           main   #180   +/-   ##
===================================
  Coverage    75%    75%           
===================================
  Files         2      2           
  Lines       370    370           
===================================
  Hits        276    276           
  Misses       94     94           

@Borda Borda merged commit e22e229 into Lightning-AI:main Jun 17, 2022
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