supervision
supervision copied to clipboard
roboflow
Resolve mkdocs issues
Description
Addressed all issues highlighted when running mkdocs serve.
Type of change
Please delete options that are not relevant.
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] This change requires a documentation update
How has this change been tested, please provide a testcase or example of how you tested the change?
- Ran
mkdocs servemaking sure there are no issues - Looked through the docs, verifying there are no regressions
Any specific deployment considerations
Extra dependency: We're now explicitly requiring a version of mkdocstrings-python, as that was not handled by mkdocstrings[python].
Docs
- [x] Docs updated? What were the changes:
Added whitespaces and Any types, primarily.
@LinasKo
- I added code-spell check, ignore notebooks (read as txt not notebook and that cause so many errors)
- I added mdformat/ruff/mkdocs to make complete re-formatting
Hey @onuralpszr, I glanced at the results - I'm really not fond of the situation where it reformats arguments split across multiple lines into a format where it's all on a single one (or packed into as few lines as possible).
This is less pleasant to look at than what we had, and we have many many cases like this.
Let's either find a way to fix it, or split the markdown formatter into a separate PR.
Hey @onuralpszr, I glanced at the results - I'm really not fond of the situation where it reformats arguments split across multiple lines into a format where it's all on a single one (or packed into as few lines as possible).
This is less pleasant to look at than what we had, and we have many many cases like this.
Let's either find a way to fix it, or split the markdown formatter into a separate PR.
Let me take look quickly to handle this (I got something in my mind)
@LinasKo I revert code parts and re-adjusted them, code-spell is our new tool for catch spelling errors and typos. I am merging in. Thank you.