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 incorrect reST indents in docs #351

Merged
merged 5 commits into from
Oct 17, 2023

Conversation

ezio-melotti
Copy link
Contributor

@ezio-melotti ezio-melotti commented Oct 15, 2023

Pull Request

Pull Request Checklist

  • Read and followed this repo's Contributing Guidelines
  • Based your PR on the latest version of the correct branch (master or 4.x)
  • Checked your writing carefully for correct English spelling, grammar, etc
  • Described your changes and the motivation for them below
  • Noted what issue(s) this pull request resolves, creating one if needed

Description of Changes

Fixes markup errors spotted by:

cc @CAM-Gerlach

Issue(s) Resolved

@CAM-Gerlach CAM-Gerlach changed the title Fix wrong reST markup Fix incorrect reST indents in docs Oct 16, 2023
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

I checked each case in the source and rendered output, and that all LGTM.

Could you (or I can, as a commit here) bump the Sphinx-Lint version to the latest 0.7.0 in the .pre-commit-config.yaml so we're actually testing this against the latest Sphinx-Lint with all the checks, and don't have any regressions (which would in turn would make for problems with Sphinx-Lint's "friends" checker). Thanks!

Also, this is blocked on #352 being merged to fix the broken links detected by linkcheck, but I'll have that merged shortly and you can rebase (or merge) it in. Thanks!

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Oct 17, 2023

(#352 is merged now, so this can be rebased or merged with master to pick that up and unblock the CI)

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Since it was straightforward and we'd discussed it, I went ahead with updating the branch and bumping the Sphinx-Lint version and everything's green now, so this LGTM and should be good to merge. Thanks @ezio-melotti !

@CAM-Gerlach CAM-Gerlach merged commit 75e0422 into spyder-ide:master Oct 17, 2023
3 checks passed
@ezio-melotti ezio-melotti deleted the fix-markup branch November 23, 2023 04:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants