-
Notifications
You must be signed in to change notification settings - Fork 39
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
make SP files linter compliant #298
Conversation
This addresses canonical#208.
Make sure to keep |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @akcano. LGTM. I haven't run the linters we use in some of our sw projects on it yet, but off the top of my head, I recall that 'pycodestyle' also complains about "too many leading '#' in block comments". So, in conf.py
, that would mean adjusting to, for example:
############################################################
# Project information
############################################################
(Only one #
on the middle line.)
url = "https://api.github.com/repos/canonical/praecepta/contents/styles/config/vocabularies/Canonical" | ||
r = requests.get(url) | ||
for item in r.json(): | ||
download = requests.get(item["download_url"]) | ||
file = open(".sphinx/styles/config/vocabularies/Canonical/" + item["name"], "w") | ||
file.write(download.text) | ||
file.close() | ||
config = requests.get("https://raw.githubusercontent.com/canonical/praecepta/main/vale.ini") | ||
config = requests.get( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just curious what linter complains about this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ruff.
OK, I'll run that as well. |
Make sure to keep |
This is probably the farthest I can take it without different linting styles bumping heads. |
This addresses #208.