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

correct italic markup in plugin stores docs #1977

Merged
merged 1 commit into from Jun 4, 2022
Merged

correct italic markup in plugin stores docs #1977

merged 1 commit into from Jun 4, 2022

Conversation

EFord36
Copy link
Contributor

@EFord36 EFord36 commented May 30, 2022

Summary of changes

Currently the doc file plugin_stores.rst uses _ in a way that appears to be intended to produce italics in the final html render, which doesn't appear to be valid ReST markup for italics. It is Markdown markup for italics (hence me reading the intention of italics in the presence of the _s).

I have changed this to use (unescaped) *s for the italics, which works as seemed to be the desired behaviour.

Checklist

  • Checked that there aren't other open pull requests for
    the same change.
  • Considered granting push permissions to the PR branch,
    so maintainers can fix minor issues and keep your PR up to date.

More Detail

Discovered this while working on PR #1976 , looking at other places where there might be that issue, but found this related one instead.

Before (i.e. live docs here):

Screenshot 2022-05-30 at 15 31 42

After (local build of docs after change):

Screenshot 2022-05-30 at 15 33 33

Similar caveats to PR #1976:

  • My PR doesn't do anything to address this re-occuring in future. I don't think there's a 'rdflib apidoc styleguide' or anything that it belongs in as human-readable, and I don't think an automatic check makes sense here since someone could want to use *s to italicise something in the docs, so it really needs a human to check/catch this.
  • After making the change, I generated the tests locally and checked the output to generate the 'after' screenshot above. I think this is all the testing needed for this change, but let me know if I should do anything else, or need to do anything related to contributing/releasing - sorry if I've missed a step here!

Copy link
Member

@aucampia aucampia left a comment

Choose a reason for hiding this comment

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

LGMT, thanks for the correction.

@aucampia aucampia requested a review from a team May 30, 2022 22:54
@aucampia aucampia added the review wanted This indicates that the PR is ready for review label May 30, 2022
@coveralls
Copy link

Coverage Status

Coverage remained the same at 88.521% when pulling 4e2a927 on EFord36:correct_italics into 4ded2eb on RDFLib:master.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Thanks for this, lgtm

@aucampia aucampia merged commit aa33f9a into RDFLib:master Jun 4, 2022
@ghost ghost removed the review wanted This indicates that the PR is ready for review label Jun 4, 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.

None yet

3 participants