[MAINTENANCE] Lint Docs #8936
Merged
[MAINTENANCE] Lint Docs #8936
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for niobium-lead-7998 canceled.
|
|
@anthonyburdi if I wanted to manually test these changes, what we be the best way to do that? Or would you expect the CI to fail if something was off? |
Kilo59
commented
Nov 7, 2023
docs/ruff.toml
Outdated
There was a problem hiding this comment.
If we want different linting rules for the docs code we can customize it in this file
Kilo59
commented
Nov 7, 2023
Comment on lines
-145
to
-157
| def _get_os_path(self, path: str) -> str: | ||
| """Gets an os-specific path from a path found in a markdown file""" | ||
| return path.replace("/", os.path.sep) |
There was a problem hiding this comment.
Don't need this method at all if using pathlib
cdkini
approved these changes
Nov 9, 2023
anthonyburdi
approved these changes
Nov 13, 2023
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #8936 +/- ##
========================================
Coverage 82.55% 82.55%
========================================
Files 511 511
Lines 46381 46381
========================================
Hits 38288 38288
Misses 8093 8093
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enable linting for the docs directory code.
Mostly involved swapping
os.pathandglobusage withpathlib.Pathmethods.Also enabled type-checking for some docs related modules.
invoke lint(usesblack+ruff)For more information about contributing, see Contribute.
After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!