[docs] Close Hacktoberfest docs tickets with fixes for Vale issues #848
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
stichbury
changed the title
View the example dashboards of the current commit live on PyCafe ☕ 🚀Updated on: 2024-11-05 13:17:54 UTC Link: vizro-core/examples/dev/ |
for more information, see https://pre-commit.ci
…vizro into docs/clear-vale-issues
for more information, see https://pre-commit.ci
…vizro into docs/clear-vale-issues
for more information, see https://pre-commit.ci
…vizro into docs/clear-vale-issues
for more information, see https://pre-commit.ci
Switch off the whole of the FAQ page
…vizro into docs/clear-vale-issues
for more information, see https://pre-commit.ci
…vizro into docs/clear-vale-issues
for more information, see https://pre-commit.ci
…vizro into docs/clear-vale-issues
for more information, see https://pre-commit.ci
…vizro into docs/clear-vale-issues
stichbury
changed the title
stichbury
requested review from
Joseph-Perkins,
antonymilne,
huong-li-nguyen,
maxschulz-COL and
lingyielia
as code owners
|
Looks good to me! (I added a comment around one word, though it might still be fine to accept the existing wording there, if that is preferred) |
Joseph-Perkins
approved these changes
Nov 4, 2024
Co-authored-by: Lingyi Zhang <[email protected]>
Co-authored-by: Lingyi Zhang <[email protected]>
stichbury
changed the title
This was referenced Nov 5, 2024
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.
Description
A set of changes to the language of the docs to fix some issues that typically complicate the language. To turn on all Vale suggestions/warnings, I dropped the word "leverage" into a page of docs. It's like a bomb went off, and all the niggles and grievances that Vale was holding onto were surfaced.
Most of them were arguable, but ideally if we can avoid "allow" when we mean "enable" and "provide" when we mean "supply" or "give" then we're helping our users parse the docs a little faster.
I turned off Vale in the FAQs page as that's rather promotional (it takes the old messaging from the readme)
A few issues with Vizro-AI docs in terms of readability: I will take a spin through these docs while @lingyielia is around this week to make sure any further tweaks (beyond what I've done here just to satisfy Vale) don't break the meaning.
Screenshot
Notice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":