Skip to content
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

Enhance Documentation for Dataset Previews #2074

Merged
merged 5 commits into from
Sep 10, 2024

Merge branch 'main' into docs/datasets-preview-docs-update

bd79d0d
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

Enhance Documentation for Dataset Previews #2074

Merge branch 'main' into docs/datasets-preview-docs-update
bd79d0d
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Sep 6, 2024 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (5)

docs/source/preview_custom_datasets.md|14 col 4| [Kedro-viz.headings] 'TablePreview' should use sentence-style capitalization.
docs/source/preview_custom_datasets.md|58 col 4| [Kedro-viz.headings] 'ImagePreview' should use sentence-style capitalization.
docs/source/preview_custom_datasets.md|75 col 4| [Kedro-viz.headings] 'PlotlyPreview' should use sentence-style capitalization.
docs/source/preview_custom_datasets.md|93 col 4| [Kedro-viz.Spellings] Did you really mean 'JSONPreview'?
docs/source/preview_custom_datasets.md|93 col 4| [Kedro-viz.headings] 'JSONPreview' should use sentence-style capitalization.

Filtered Findings (714)

demo-project/src/demo_project/pipelines/modelling/README.md|3 col 97| [Kedro-viz.toowordy] 'modify' is too wordy
demo-project/src/demo_project/pipelines/modelling/README.md|7 col 133| [Kedro-viz.Spellings] Did you really mean 'Sklearn'?
demo-project/src/demo_project/pipelines/modelling/README.md|8 col 3| [Kedro-viz.toowordy] 'In order to' is too wordy
demo-project/conf/README.md|5 col 149| [Kedro-viz.toowordy] 'however' is too wordy
demo-project/conf/README.md|5 col 187| [Kedro-viz.toowordy] 'retain' is too wordy
demo-project/conf/README.md|9 col 83| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
demo-project/conf/README.md|9 col 121| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
demo-project/src/demo_project/pipelines/feature_engineering/README.md|3 col 97| [Kedro-viz.toowordy] 'modify' is too wordy
demo-project/src/demo_project/pipelines/feature_engineering/README.md|7 col 74| [Kedro-viz.words] Use '' instead of 'just'.
demo-project/src/demo_project/pipelines/reporting/README.md|3 col 97| [Kedro-viz.toowordy] 'modify' is too wordy
demo-project/src/demo_project/pipelines/reporting/README.md|5 col 35| [Kedro-viz.words] Use '' instead of 'simple'.
demo-project/src/demo_project/pipelines/reporting/README.md|11 col 99| [Kedro-viz.weaselwords] 'really' is a weasel word!
demo-project/src/demo_project/pipelines/reporting/README.md|11 col 144| [Kedro-viz.weaselwords] 'mostly' is a weasel word!
demo-project/src/demo_project/pipelines/reporting/README.md|11 col 163| [Kedro-viz.words] Use '' instead of 'easy'.
.github/ISSUE_TEMPLATE/feature-request.md|11 col 104| [Kedro-viz.pronouns] Avoid first-person singular pronouns such as 'I'm'.
.github/ISSUE_TEMPLATE/feature-request.md|16 col 4| [Kedro-viz.headings] 'Possible Implementation' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/feature-request.md|19 col 4| [Kedro-viz.headings] 'Possible Alternatives' should use sentence-style capitalization.
demo-project/README.md|1 col 3| [Kedro-viz.headings] 'demo-project' should use sentence-style capitalization.
demo-project/src/demo_project/pipelines/data_ingestion/README.md|1 col 3| [Kedro-viz.headings] 'Data Ingestion modular pipeline' should use sentence-style capitalization.
demo-project/src/demo_project/pipelines/data_ingestion/README.md|4 col 3| [Kedro-viz.toowordy] 'In order to' is too wordy
demo-project/src/demo_project/pipelines/data_ingestion/README.md|4 col 58| [Kedro-viz.toowordy] 'aggregate' is too wordy
demo-project/src/demo_project/pipelines/data_ingestion/README.md|5 col 37| [Kedro-viz.words] Use '' instead of 'just'.
.github/PULL_REQUEST_TEMPLATE.md|9 col 4| [Kedro-viz.headings] 'QA notes' should use sentence-style capitalization.
.github/PULL_REQUEST_TEMPLATE.md|19 col 28| [Kedro-viz.pronouns] Avoid first-person singular pronouns such as 'my'.
.github/ISSUE_TEMPLATE/bug-report.md|14 col 56| [Kedro-viz.toowordy] 'accomplish' is too wordy
.github/ISSUE_TEMPLATE/bug-report.md|16 col 4| [Kedro-viz.headings] 'Steps to Reproduce' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|22 col 4| [Kedro-viz.headings] 'Expected Result' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|25 col 4| [Kedro-viz.headings] 'Actual Result' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|36 col 4| [Kedro-viz.headings] 'Your Environment' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|37 col 12| [Kedro-viz.weaselwords] 'many' is a weasel word!
CODE_OF_CONDUCT.md|1 col 3| [Kedro-viz.headings] 'Contributor Covenant Code of Conduct' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|3 col 4| [Kedro-viz.headings] 'Our Pledge' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|5 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|12 col 4| [Kedro-viz.headings] 'Our Standards' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|19 col 3| [Kedro-viz.weaselwords] 'Gracefully' is a weasel word!
CODE_OF_CONDUCT.md|25 col 14| [Kedro-viz.Spellings] Did you really mean 'sexualised'?
CODE_OF_CONDUCT.md|34 col 4| [Kedro-viz.headings] 'Our Responsibilities' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|40 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|49 col 66| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|51 col 18| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
CODE_OF_CONDUCT.md|64 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|68 col 82| [Kedro-viz.toowordy] 'initiate' is too wordy
CODE_OF_CONDUCT.md|68 col 127| [Kedro-viz.weaselwords] 'timely' is a weasel word!
CODE_OF_CONDUCT.md|68 col 160| [Kedro-viz.toowordy] 'type of' is too wordy
README.npm.md|11 col 32| [Kedro-viz.weaselwords] 'Beautifully' is a weasel word!
README.npm.md|23 col 4| [Kedro-viz.Spellings] Did you really mean 'npm'?
README.npm.md|41 col 6| [Kedro-viz.Spellings] Did you really mean 'Autoreload'?
README.npm.md|43 col 5| [Kedro-viz.weaselwords] 'Many' is a weasel word!
README.npm.md|113 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
README.npm.md|152 col 112| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
README.npm.md|154 col 26| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|155 col 17| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|156 col 24| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|157 col 16| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|158 col 16| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|159 col 21| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|160 col 15| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|161 col 15| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|162 col 19| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|163 col 32| [Kedro-viz.Spellings] Did you really mean 'boolean'?
README.npm.md|170 col 34| [Kedro-viz.weaselwords] 'only' is a weasel word!
README.npm.md|178 col 4| [Kedro-viz.headings] 'Standalone Example Repository' should use sentence-style capitalization.
README.npm.md|180 col 111| [Kedro-viz.toowordy] 'demonstrate' is too wordy
README.npm.md|193 col 4| [Kedro-viz.headings] 'Feature Flags' should use sentence-style capitalization.
README.npm.md|199 col 3| [Kedro-viz.Spellings] Did you really mean 'sizewarning'?
README.npm.md|199 col 77| [Kedro-viz.weaselwords] 'very' is a weasel word!
README.npm.md|199 col 77| [Kedro-viz.words] Use '' instead of 'very'.
README.npm.md|204 col 238| [Kedro-viz.weaselwords] 'currently' is a weasel word!
README.npm.md|208 col 148| [Kedro-viz.toowordy] 'a number of' is too wordy
README.npm.md|208 col 148| [Kedro-viz.words] Use 'few', 'several', or 'many' instead of 'a number of'.
README.npm.md|212 col 41| [Kedro-viz.words] Use '' instead of 'please'.
README.npm.md|220 col 168| [Kedro-viz.Spellings] Did you really mean 'Zenodo'?
STYLE_GUIDE.md|7 col 43| [Kedro-viz.Spellings] Did you really mean 'ESLint'?
STYLE_GUIDE.md|7 col 78| [Kedro-viz.Spellings] Did you really mean 'stylelint'?
STYLE_GUIDE.md|7 col 145| [Kedro-viz.toowordy] 'For the most part' is too wordy
STYLE_GUIDE.md|7 col 339| [Kedro-viz.Spellings] Did you really mean 'ESLint'?
STYLE_GUIDE.md|7 col 351| [Kedro-viz.Spellings] Did you really mean 'stylelint'?
STYLE_GUIDE.md|9 col 21| [Kedro-viz.weaselwords] 'mostly' is a weasel word!
STYLE_GUIDE.md|13 col 62| [Kedro-viz.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
STYLE_GUIDE.md|13 col 67| [Kedro-viz.Spellings] Did you really mean 'Chome'?
STYLE_GUIDE.md|13 col 135| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|13 col 225| [Kedro-viz.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
STYLE_GUIDE.md|17 col 153| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.
STYLE_GUIDE.md|19 col 61| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
STYLE_GUIDE.md|19 col 106| [Kedro-viz.words] Use '' instead of 'obvious'.
STYLE_GUIDE.md|19 col 194| [Kedro-viz.toowordy] 'sufficient' is too wordy
STYLE_GUIDE.md|19 col 392| [Kedro-viz.Spellings] Did you really mean 'screenreader'?
STYLE_GUIDE.md|23 col 4| [Kedro-viz.headings] 'Semantic HTML' should use sentence-style capitalization.
STYLE_GUIDE.md|51 col 4| [Kedro-viz.headings] 'CSS' should use sentence-style capitalization.
STYLE_GUIDE.md|55 col 57| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
STYLE_GUIDE.md|55 col 269| [Kedro-viz.Spellings] Did you really mean 'impove'?
STYLE_GUIDE.md|59 col 134| [Kedro-viz.toowordy] 'However' is too wordy
STYLE_GUIDE.md|89 col 53| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|89 col 87| [Kedro-viz.toowordy] 'in order to' is too wordy
STYLE_GUIDE.md|89 col 87| [Kedro-viz.words] Use 'to' instead of 'in order to'.
STYLE_GUIDE.md|89 col 142| [Kedro-viz.abbreviations] Use 'and more' instead of abbreviations like 'etc,'.
STYLE_GUIDE.md|89 col 181| [Kedro-viz.weaselwords] 'relatively' is a weasel word!
STYLE_GUIDE.md|89 col 355| [Kedro-viz.toowordy] 'equivalent' is too wordy
STYLE_GUIDE.md|93 col 69| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
STYLE_GUIDE.md|93 col 168| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|93 col 189| [Kedro-viz.Spellings] Did you really mean 'viewport'?
STYLE_GUIDE.md|93 col 205| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
STYLE_GUIDE.md|97 col 76| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|97 col 168| [Kedro-viz.toowordy] 'multiple' is too wordy
STYLE_GUIDE.md|97 col 438| [Kedro-viz.toowordy] 'multiple' is too wordy
STYLE_GUIDE.md|117 col 115| [Kedro-viz.words] Use 'see', 'read', or 'follow' instead of 'refer to'.
STYLE_GUIDE.md|119 col 13| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'Color'.
STYLE_GUIDE.md|119 col 19| [Kedro-viz.Spellings] Did you really mean 'Styleguide'?
STYLE_GUIDE.md|153 col 4| [Kedro-viz.headings] 'JavaScript' should use sentence-style capitalization.
STYLE_GUIDE.md|157 col 1| [Kedro-viz.toowordy] 'In order to' is too wordy
STYLE_GUIDE.md|157 col 48| [Kedro-viz.weaselwords] 'many' is a weasel word!
STYLE_GUIDE.md|157 col 199| [Kedro-viz.words] Use '' instead of 'easily'.
STYLE_GUIDE.md|157 col 199| [Kedro-viz.weaselwords] 'easily' is a weasel word!
STYLE_GUIDE.md|159 col 13| [Kedro-viz.words] Use '' instead of 'easily'.
STYLE_GUIDE.md|159 col 13| [Kedro-viz.weaselwords] 'easily' is a weasel word!
STYLE_GUIDE.md|171 col 39| [Kedro-viz.toowordy] 'indicate' is too wordy
STYLE_GUIDE.md|173 col 23| [Kedro-viz.words] Use '' instead of 'easily'.
STYLE_GUIDE.md|173 col 23| [Kedro-viz.weaselwords] 'easily' is a weasel word!
STYLE_GUIDE.md|193 col 10| [Kedro-viz.Spellings] Did you really mean 'camelCase'?
STYLE_GUIDE.md|201 col 14| [Kedro-viz.Spellings] Did you really mean 'snake_case'?
STYLE_GUIDE.md|205 col 13| [Kedro-viz.weaselwords] 'few' is a weasel word!
STYLE_GUIDE.md|205 col 124| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
STYLE_GUIDE.md|205 col 194| [Kedro-viz.words] Use 'generally' or 'usually' instead of 'for the most part'.
STYLE_GUIDE.md|205 col 194| [Kedro-viz.toowordy] 'for the most part' is too wordy
STYLE_GUIDE.md|207 col 3| [Kedro-viz.oxfordcomma] Use the Oxford comma in 'AVOID using abbreviations, acronyms or'.
STYLE_GUIDE.md|209 col 169| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
STYLE_GUIDE.md|213 col 242| [Kedro-viz.Spellings] Did you really mean 'webpack'?
STYLE_GUIDE.md|213 col 458| [Kedro-viz.weaselwords] 'fairly' is a weasel word!
STYLE_GUIDE.md|217 col 1| [Kedro-viz.toowordy] 'In accordance with' is too wordy
STYLE_GUIDE.md|217 col 130| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|217 col 197| [Kedro-viz.weaselwords] 'usually' is a weasel word!
STYLE_GUIDE.md|225 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|227 col 4| [Kedro-viz.headings] 'Git and Github' should use sentence-style capitalization.
STYLE_GUIDE.md|227 col 12| [Kedro-viz.Spellings] Did you really mean 'Github'?
STYLE_GUIDE.md|264 col 5| [Kedro-viz.headings] 'Pull Requests' should use sentence-style capitalization.
STYLE_GUIDE.md|276 col 214| [Kedro-viz.Spellings] Did you really mean 'QAing'?
STYLE_GUIDE.md|276 col 246| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
STYLE_GUIDE.md|280 col 50| [Kedro-viz.weaselwords] 'usually' is a weasel word!
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|1 col 3| [Kedro-viz.headings] '[Technical Design] Expanse & Collapse of Modular Pipelines' should use sentence-style capitalization.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|12 col 67| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'materialized'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|14 col 9| [Kedro-viz.words] Use '' instead of 'easy'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|14 col 80| [Kedro-viz.words] Use '' instead of 'just'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|15 col 72| [Kedro-viz.words] Use '' instead of 'just'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|15 col 105| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'materialized'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|17 col 63| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|21 col 1| [Kedro-viz.toowordy] 'On the other hand' is too wordy
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|55 col 67| [Kedro-viz.weaselwords] 'easily' is a weasel word!
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|55 col 67| [Kedro-viz.words] Use '' instead of 'easily'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|55 col 79| [Kedro-viz.words] Use '' instead of 'simple'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|57 col 4| [Kedro-viz.headings] 'Technical Design' should use sentence-style capitalization.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|63 col 42| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'materialized'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|118 col 1| [Kedro-viz.toowordy] 'Due to the fact that' is too wordy
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|118 col 52| [Kedro-viz.toowordy] 'multiple' is too wordy
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|121 col 51| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualized'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|122 col 27| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualized'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|125 col 73| [Kedro-viz.weaselwords] 'simply' is a weasel word!
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|125 col 73| [Kedro-viz.words] Use '' instead of 'simply'.
package/kedro_viz/docs/technical_design_expand_collapse_modular_pipelines.md|125 col 98| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.
LICENSE.md|9 col 17| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|12 col 8| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|12 col 18| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|12 col 59| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'authorized'.
LICENSE.md|15 col 22| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|17 col 33| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|23 col 25| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|26 col 21| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|30 col 8| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|30 col 21| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|35 col 8| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|35 col 14| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|40 col 8| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|40 col 26| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|43 col 62| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|44 col 41| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|48 col 8| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|48 col 22| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|51 col 20| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|52 col 43| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'authorized'.
LICENSE.md|53 col 28| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|55 col 14| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|58 col 7| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|58 col 16| [Kedro-viz.toowordy] 'for the purpose of' is too wordy
LICENSE.md|62 col 21| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|62 col 32| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|63 col 61| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|70 col 43| [Kedro-viz.Spellings] Did you really mean 'sublicense'?
LICENSE.md|78 col 34| [Kedro-viz.weaselwords] 'only' is a weasel word!
LICENSE.md|84 col 54| [Kedro-viz.toowordy] 'constitutes' is too wordy
LICENSE.md|86 col 55| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|86 col 61| [Kedro-viz.toowordy] 'terminate' is too wordy
LICENSE.md|91 col 52| [Kedro-viz.toowordy] 'provided that' is too wordy
LICENSE.md|100 col 8| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|100 col 20| [Kedro-viz.toowordy] 'retain' is too wordy
LICENSE.md|106 col 8| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|107 col 56| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|115 col 45| [Kedro-viz.weaselwords] 'normally' is a weasel word!
LICENSE.md|116 col 61| [Kedro-viz.weaselwords] 'only' is a weasel word!
LICENSE.md|117 col 18| [Kedro-viz.toowordy] 'modify' is too wordy
LICENSE.md|123 col 7| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|132 col 30| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|134 col 7| [Kedro-viz.toowordy] 'Notwithstanding' is too wordy
LICENSE.md|134 col 49| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|134 col 68| [Kedro-viz.toowordy] 'modify' is too wordy
LICENSE.md|136 col 12| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|136 col 21| [Kedro-viz.toowordy] 'regarding' is too wordy
LICENSE.md|139 col 65| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|144 col 29| [Kedro-viz.Spellings] Did you really mean 'Licensor'?
LICENSE.md|156 col 48| [Kedro-viz.toowordy] 'shall' is too wordy
LICENSE.md|168 col 38| [Kedro-viz.words] Use 'and', 'or', or 'either or' instead of 'and/or'.
LICENSE.md|169 col 16| [Kedro-viz.toowordy] 'However' is too wordy
LICENSE.md|169 col 68| [Kedro-viz.weaselwords] 'only' is a weasel word!
LICENSE.md|171 col 37| [Kedro-viz.weaselwords] 'only' is a weasel word!
LICENSE.md|189 col 15| [Kedro-viz.Spellings] Did you really mean 'yyyy'?
LICENSE.md|193 col 12| [Kedro-viz.toowordy] 'obtain' is too wordy
LICENSE.md|197 col 4| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/preview_pandas_datasets.md|3 col 82| [Kedro-viz.toowordy] 'demonstrate' is too wordy
docs/source/preview_pandas_datasets.md|3 col 172| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|10 col 4| [Kedro-viz.headings] 'High-level Overview' should use sentence-style capitalization.
ARCHITECTURE.md|12 col 168| [Kedro-viz.toowordy] 'It was' is too wordy
ARCHITECTURE.md|17 col 45| [Kedro-viz.Spellings] Did you really mean 'npm'?
ARCHITECTURE.md|19 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|19 col 146| [Kedro-viz.words] Use '' instead of 'simple'.
ARCHITECTURE.md|23 col 64| [Kedro-viz.Spellings] Did you really mean 'transpiled'?
ARCHITECTURE.md|23 col 111| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|23 col 205| [Kedro-viz.Spellings] Did you really mean 'webpack'?
ARCHITECTURE.md|23 col 266| [Kedro-viz.Spellings] Did you really mean 'webpack'?
ARCHITECTURE.md|25 col 32| [Kedro-viz.Spellings] Did you really mean 'npm'?
ARCHITECTURE.md|25 col 81| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
ARCHITECTURE.md|35 col 54| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
ARCHITECTURE.md|35 col 60| [Kedro-viz.Spellings] Did you really mean 'json'?
ARCHITECTURE.md|45 col 84| [Kedro-viz.Spellings] Did you really mean 'json'?
ARCHITECTURE.md|47 col 5| [Kedro-viz.headings] 'Pipeline API endpoints' should use sentence-style capitalization.
ARCHITECTURE.md|49 col 174| [Kedro-viz.weaselwords] 'Only' is a weasel word!
ARCHITECTURE.md|51 col 199| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|51 col 375| [Kedro-viz.toowordy] 'However' is too wordy
ARCHITECTURE.md|51 col 446| [Kedro-viz.toowordy] 'in order to' is too wordy
ARCHITECTURE.md|51 col 446| [Kedro-viz.words] Use 'to' instead of 'in order to'.
ARCHITECTURE.md|53 col 5| [Kedro-viz.headings] 'Node API endpoints' should use sentence-style capitalization.
ARCHITECTURE.md|57 col 4| [Kedro-viz.headings] 'localStorage' should use sentence-style capitalization.
ARCHITECTURE.md|57 col 4| [Kedro-viz.Spellings] Did you really mean 'localStorage'?
ARCHITECTURE.md|59 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|61 col 80| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
ARCHITECTURE.md|67 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|67 col 11| [Kedro-viz.weaselwords] 'currently' is a weasel word!
ARCHITECTURE.md|67 col 155| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
ARCHITECTURE.md|69 col 117| [Kedro-viz.words] Use 'to' instead of 'in order to'.
ARCHITECTURE.md|69 col 117| [Kedro-viz.toowordy] 'in order to' is too wordy
ARCHITECTURE.md|69 col 162| [Kedro-viz.Spellings] Did you really mean 'performant'?
ARCHITECTURE.md|73 col 101| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|73 col 231| [Kedro-viz.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
ARCHITECTURE.md|75 col 109| [Kedro-viz.words] Use 'after' instead of 'once'.
ARCHITECTURE.md|75 col 366| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|75 col 501| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
ARCHITECTURE.md|75 col 526| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
ARCHITECTURE.md|75 col 583| [Kedro-viz.words] Use 'frontend' instead of 'front end'.
ARCHITECTURE.md|77 col 97| [Kedro-viz.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
ARCHITECTURE.md|77 col 103| [Kedro-viz.words] Use 'with' or 'through' instead of 'via'.
ARCHITECTURE.md|81 col 162| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
ARCHITECTURE.md|85 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|93 col 62| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|93 col 346| [Kedro-viz.words] Use 'to' instead of 'in order to'.
ARCHITECTURE.md|93 col 346| [Kedro-viz.toowordy] 'in order to' is too wordy
ARCHITECTURE.md|101 col 58| [Kedro-viz.Spellings] Did you really mean 'combineReducers'?
ARCHITECTURE.md|105 col 46| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|105 col 193| [Kedro-viz.Spellings] Did you really mean 'memoised'?
ARCHITECTURE.md|105 col 202| [Kedro-viz.words] Use 'to' instead of 'in order to'.
ARCHITECTURE.md|105 col 202| [Kedro-viz.toowordy] 'in order to' is too wordy
ARCHITECTURE.md|105 col 287| [Kedro-viz.toowordy] 'In order to' is too wordy
ARCHITECTURE.md|105 col 287| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|105 col 329| [Kedro-viz.weaselwords] 'occasionally' is a weasel word!
ARCHITECTURE.md|107 col 27| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualize'.
ARCHITECTURE.md|107 col 70| [Kedro-viz.words] Use 'see', 'read', or 'follow' instead of 'visit'.
ARCHITECTURE.md|111 col 142| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|113 col 221| [Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.
ARCHITECTURE.md|121 col 4| [Kedro-viz.Spellings] Did you really mean 'Utils'?
ARCHITECTURE.md|127 col 113| [Kedro-viz.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
ARCHITECTURE.md|127 col 118| [Kedro-viz.words] Use 'Note:' instead of 'Note that'.
ARCHITECTURE.md|131 col 88| [Kedro-viz.Spellings] Did you really mean 'minimap'?
ARCHITECTURE.md|137 col 102| [Kedro-viz.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
ARCHITECTURE.md|147 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
ARCHITECTURE.md|147 col 130| [Kedro-viz.toowordy] 'in order to' is too wordy
ARCHITECTURE.md|147 col 130| [Kedro-viz.words] Use 'to' instead of 'in order to'.
ARCHITECTURE.md|147 col 199| [Kedro-viz.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/index.md|16 col 3| [Kedro-viz.oxfordcomma] Use the Oxford comma in 'Highly interactive, filterable and'.
docs/source/index.md|18 col 58| [Kedro-viz.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/index.md|20 col 4| [Kedro-viz.Spellings] Did you really mean 'Autoreload'?
package/README.md|11 col 32| [Kedro-viz.weaselwords] 'Beautifully' is a weasel word!
package/README.md|23 col 4| [Kedro-viz.Spellings] Did you really mean 'npm'?
package/README.md|39 col 60| [Kedro-viz.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
package/README.md|41 col 6| [Kedro-viz.Spellings] Did you really mean 'Autoreload'?
package/README.md|43 col 5| [Kedro-viz.weaselwords] 'Many' is a weasel word!
package/README.md|205 col 5| [Kedro-viz.headings] 'Experiment Tracking usage' should use sentence-style capitalization.
package/README.md|222 col 26| [Kedro-viz.weaselwords] 'only' is a weasel word!
package/README.md|223 col 3| [Kedro-viz.toowordy] 'Prior to' is too wordy
package/README.md|232 col 5| [Kedro-viz.headings] 'Standalone React component usage' should use sentence-style capitalization.
package/README.md|234 col 85| [Kedro-viz.toowordy] 'However' is too wordy
package/README.md|234 col 94| [Kedro-viz.words] Use '' instead of 'please'.
package/README.md|269 col 1| [Kedro-viz.sentencelength] Try to keep your sentence length to 30 words or fewer.
package/README.md|275 col 4| [Kedro-viz.headings] 'Feature Flags' should use sentence-style capitalization.
package/README.md|277 col 95| [Kedro-viz.weaselwords] 'currently' is a weasel word!
package/README.md|281 col 3| [Kedro-viz.Spellings] Did you really mean 'sizewarning'?
package/README.md|281 col 77| [Kedro-viz.words] Use '' instead of 'very'.
package/README.md|281 col 77| [Kedro-viz.weaselwords] 'very' is a weasel word!
package/README.md|286 col 238| [Kedro-viz.weaselwords] 'currently' is a weasel word!
package/README.md|290 col 148| [Kedro-viz.toowordy] 'a number of' is too wordy
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 14 in docs/source/preview_custom_datasets.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/preview_custom_datasets.md#L14

[Kedro-viz.headings] 'TablePreview' should use sentence-style capitalization.
Raw output
{"message": "[Kedro-viz.headings] 'TablePreview' should use sentence-style capitalization.", "location": {"path": "docs/source/preview_custom_datasets.md", "range": {"start": {"line": 14, "column": 4}}}, "severity": "WARNING"}

Check warning on line 58 in docs/source/preview_custom_datasets.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/preview_custom_datasets.md#L58

[Kedro-viz.headings] 'ImagePreview' should use sentence-style capitalization.
Raw output
{"message": "[Kedro-viz.headings] 'ImagePreview' should use sentence-style capitalization.", "location": {"path": "docs/source/preview_custom_datasets.md", "range": {"start": {"line": 58, "column": 4}}}, "severity": "WARNING"}

Check warning on line 75 in docs/source/preview_custom_datasets.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/preview_custom_datasets.md#L75

[Kedro-viz.headings] 'PlotlyPreview' should use sentence-style capitalization.
Raw output
{"message": "[Kedro-viz.headings] 'PlotlyPreview' should use sentence-style capitalization.", "location": {"path": "docs/source/preview_custom_datasets.md", "range": {"start": {"line": 75, "column": 4}}}, "severity": "WARNING"}

Check warning on line 93 in docs/source/preview_custom_datasets.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/preview_custom_datasets.md#L93

[Kedro-viz.Spellings] Did you really mean 'JSONPreview'?
Raw output
{"message": "[Kedro-viz.Spellings] Did you really mean 'JSONPreview'?", "location": {"path": "docs/source/preview_custom_datasets.md", "range": {"start": {"line": 93, "column": 4}}}, "severity": "WARNING"}

Check warning on line 93 in docs/source/preview_custom_datasets.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/preview_custom_datasets.md#L93

[Kedro-viz.headings] 'JSONPreview' should use sentence-style capitalization.
Raw output
{"message": "[Kedro-viz.headings] 'JSONPreview' should use sentence-style capitalization.", "location": {"path": "docs/source/preview_custom_datasets.md", "range": {"start": {"line": 93, "column": 4}}}, "severity": "WARNING"}