-
Notifications
You must be signed in to change notification settings - Fork 144
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
[Tidy] Apply mdformat to markdown files #873
Conversation
…s, add some FIXME
for more information, see https://pre-commit.ci
View the example dashboards of the current commit live on PyCafe ☕ 🚀Updated on: 2024-12-03 21:34:10 UTC Link: vizro-core/examples/dev/ Link: vizro-core/examples/scratch_dev |
Looks like we might need to disable |
…ormat # Conflicts: # vizro-ai/docs/index.md # vizro-ai/docs/pages/user-guides/chart-examples.md # vizro-ai/docs/pages/user-guides/create-advanced-charts.md # vizro-ai/docs/pages/user-guides/create-complex-dashboard.md # vizro-ai/docs/pages/user-guides/retrieve-dashboard-code.md # vizro-core/changelog.d/20241030_170000_antony.milne_vvv_link_targets.md # vizro-core/changelog.d/20241105_170003_antony.milne_new_interaction.md # vizro-core/changelog.d/20241106_104745_antony.milne_dynamic_filter_2.md # vizro-core/changelog.d/20241106_134102_alexey_snigir_pytest_warning_ignore.md # vizro-core/changelog.d/20241112_120233_huong_li_nguyen_fix_404_page.md # vizro-core/docs/pages/explanation/authors.md # vizro-core/docs/pages/user-guides/card-button.md # vizro-core/examples/visual-vocabulary/README.md
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…o tidy/mdformat
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.
Phew, thanks @antonymilne this was a huge one to coordinate. Docs look fine for core.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
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.
Great initiative!! This tool cleans our docs really well 👍
Description
Technical reviewers, please look at the built HTML rather than the diffs, since there are a lot of files changed in small fiddly pointless ways to appease mdformat.
Please focus on checking things like admonitions (do they still look as they should) and code snippets: are they OK?
Background from @antonymilne
Initial step towards #719 which actually formats very little of our code and instead applies a general markdown linter across our whole repo. Code formatting will follow in a later PR.
I have played around with various
mdformat
options and plugins for quite a long time now and I still do not fully understand how it behaves, which make me feel a bit uneasy... But it did help catch several errors in our yaml and seems to have done a generally good job tidying things up.The most controversial change (which is responsible for 90% of the diff) is that I set
keep=no
to remove word wrapping. This is something I've wanted to do for a long time (just use word wrapping in your editor with whatever width you like) but I am not strongly wedded to it if others disagree. wdyt @stichbury?Worth knowing
We have now removed Vale from standard checking as it is not playing nicely with mdformat
To do list
What needs to done still in this PR:
FIXME
points @stichburydiff
compared to the current version)Follow up work
mdformat-ruff
ormdformat-black
orblacken-docs
(preference is in that order), ideally with good line length @antonymilne. Needs to work for{.python}
code blocks: easiest way is to dopython {pycafe-link title="a"}
. Tracked in Apply code formatting to code examples in our docs #719custom-components.md
doesn't get formatted and un-ignore it @stichburyNotice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":