spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment
https://docs.spyder-ide.org
MIT License
33 stars 283 forks source link

Bump to sphinx-lint v0.5 (new argument parsing) #316

Closed JulienPalard closed 2 years ago

JulienPalard commented 2 years ago

Pull Request

Pull Request Checklist

Description of Changes

I changed the way sphinx-lint parses its arguments to a more readable/simple/verbose way. Therefore, to avoid you the pain of understanding my changes, while I have my changes in mind, I opened this nice little PR to update your invocation to the new style without changing which checkers are ran.

In the meantime I learnt that spyder uses sphinx-lint so I added your doc to sphinx-lint tests to ensure we'll never introduce a false positive in your doc ♥

Issue(s) Resolved

None, sadly.

CAM-Gerlach commented 2 years ago

Oops, forgot to retarget this on the still-semi-maintained 4.x branch instead, so I just cherry-picked the commit and then null-merged it again back forward.

Read and followed this repo's Contributing Guidelines (quickly þ)

Thanks to your comment, I actually noticed that the link has been pointing to our Contributing Guide on the main Spyder repo, not the actual docs Contributing Guide. Apparently, a long, long ago in a decade far far away when after I created this repo, I'd copied over some update I'd made to the main Spyder repo's issue template and forgot to re-update the Contributing Guide link to point back to this repo's much more relevant version, so all these years, the link has been pointing to the wrong one. I've finally fixed that in #317 . Thanks again!