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 RST documentation compilation errors introduced at various times in past #1301

Merged
merged 1 commit into from
Oct 1, 2020

Conversation

robfrawley
Copy link
Collaborator

Q A
Branch? 2.0
Bug fix? yes
New feature? no
BC breaks? no
Deprecations? o
Tests pass? yes
Fixed tickets
License MIT
Doc PR

This PR fixes three compilation errors that were introduced into the RST documentation at various points in the past, including:

As a result of the above fixed RST syntax issues, the documentation again compiled as expected without errors or warnings.

@robfrawley robfrawley added Level: Bug 🐞 This item involves a legitimate regression (bug) to existing functionality. Type: Documentation This item pertains to documentation of this project. State: Confirmed This item has been confirmed by maintainers as legitimate. labels Sep 30, 2020
@robfrawley robfrawley requested a review from dbu September 30, 2020 16:46
@robfrawley robfrawley self-assigned this Sep 30, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 72.871% when pulling f39242e on robfrawley:fix-documentation into 69966ef on liip:master.

Copy link
Member

@dbu dbu left a comment

Choose a reason for hiding this comment

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

thanks!
is the doc built in the ci so that we can directly notice errors when they are introduced?

@dbu dbu merged commit e7e4e9b into liip:master Oct 1, 2020
@robfrawley
Copy link
Collaborator Author

thanks!
is the doc built in the ci so that we can directly notice errors when they are introduced?

@dbu: ATM, docs are not automatically built, but I am working a PR to introduce that so we can catch docs errors earlier in the future. Will follow up with additional PR once completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Level: Bug 🐞 This item involves a legitimate regression (bug) to existing functionality. State: Confirmed This item has been confirmed by maintainers as legitimate. Type: Documentation This item pertains to documentation of this project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants