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

[Ready] Docs changes to remove pandas-iris and update kedro new flow in onboarding docs #3317

Merged
merged 45 commits into from
Nov 27, 2023

Updates following review

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

[Ready] Docs changes to remove pandas-iris and update kedro new flow in onboarding docs #3317

Updates following review
7cb1dd4
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Nov 27, 2023 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (22)

docs/source/faq/faq.md|7 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|9 col 13| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|22 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|22 col 19| [Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
docs/source/get_started/new_project.md|49 col 60| [Kedro.words] Use 'after' instead of 'once'.
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|9 col 335| [Kedro.words] Use '' instead of 'just'.
docs/source/deployment/distributed.md|43 col 79| [Kedro.weaselwords] 'regularly' is a weasel word!
docs/source/starters/index.md|2 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/index.md|2 col 75| [Kedro.words] Use 'after' instead of 'once'.
docs/source/starters/index.md|14 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/index.md|18 col 40| [Kedro.weaselwords] 'additionally' is a weasel word!
docs/source/starters/index.md|43 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/starters/index.md|43 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/starters/starters.md|55 col 43| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/starters/create_a_starter.md|38 col 8| [Kedro.words] Use '' instead of 'very'.
docs/source/starters/create_a_starter.md|38 col 8| [Kedro.weaselwords] 'very' is a weasel word!
docs/source/starters/create_a_starter.md|40 col 80| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/starters/create_a_starter.md|40 col 149| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/starters/create_a_starter.md|40 col 196| [Kedro.Spellings] Did you really mean 'cookiecutter'?
docs/source/starters/create_a_starter.md|62 col 44| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/starters/create_a_starter.md|119 col 71| [Kedro.toowordy] 'multiple' is too wordy
docs/source/starters/create_a_starter.md|119 col 198| [Kedro.weaselwords] 'only' is a weasel word!

Filtered Findings (1479)

CODE_OF_CONDUCT.md|1 col 3| [Kedro.headings] 'Contributor Covenant Code of Conduct' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|3 col 4| [Kedro.headings] 'Our Pledge' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|5 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|12 col 4| [Kedro.headings] 'Our Standards' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|19 col 3| [Kedro.weaselwords] 'Gracefully' is a weasel word!
CODE_OF_CONDUCT.md|25 col 14| [Kedro.Spellings] Did you really mean 'sexualised'?
CODE_OF_CONDUCT.md|34 col 4| [Kedro.headings] 'Our Responsibilities' should use sentence-style capitalization.
CODE_OF_CONDUCT.md|40 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|49 col 66| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|51 col 18| [Kedro.words] Use 'with' or 'through' instead of 'via'.
CODE_OF_CONDUCT.md|64 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
CODE_OF_CONDUCT.md|68 col 82| [Kedro.toowordy] 'initiate' is too wordy
CODE_OF_CONDUCT.md|68 col 127| [Kedro.weaselwords] 'timely' is a weasel word!
CODE_OF_CONDUCT.md|68 col 160| [Kedro.toowordy] 'type of' is too wordy
docs/source/logging/index.md|6 col 20| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/logging/index.md|9 col 270| [Kedro.Spellings] Did you really mean 'traceback'?
docs/source/logging/index.md|12 col 34| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/logging/index.md|39 col 45| [Kedro.toowordy] 'subsequent' is too wordy
docs/source/logging/index.md|113 col 64| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/logging/index.md|117 col 1| [Kedro.toowordy] 'In addition' is too wordy
docs/source/logging/index.md|126 col 293| [Kedro.toowordy] 'However' is too wordy
docs/source/logging/index.md|132 col 277| [Kedro.Spellings] Did you really mean 'traceback's'?
docs/source/logging/index.md|147 col 141| [Kedro.words] Use '' instead of 'easy'.
docs/source/logging/index.md|147 col 157| [Kedro.toowordy] 'However' is too wordy
docs/source/logging/index.md|147 col 198| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/logging/index.md|147 col 231| [Kedro.Spellings] Did you really mean 'Repos'?
docs/source/logging/index.md|157 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/logging/index.md|171 col 255| [Kedro.words] Use '' instead of 'just'.
docs/source/logging/index.md|171 col 280| [Kedro.weaselwords] 'likely' is a weasel word!
docs/source/logging/index.md|171 col 331| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/logging/index.md|173 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
README.md|13 col 4| [Kedro.weaselwords] 'Monthly' is a weasel word!
README.md|24 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|44 col 53| [Kedro.words] Use '' instead of 'easy'.
README.md|45 col 100| [Kedro.weaselwords] 'many' is a weasel word!
README.md|50 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|69 col 140| [Kedro.Spellings] Did you really mean 'unvetted'?
README.md|81 col 129| [Kedro.toowordy] 'a number of' is too wordy
README.md|81 col 129| [Kedro.words] Use 'few', 'several', or 'many' instead of 'a number of'.
README.md|83 col 4| [Kedro.headings] 'Can I contribute?' should use sentence-style capitalization.
README.md|83 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|87 col 14| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|91 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
README.md|93 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|98 col 131| [Kedro.Spellings] Did you really mean 'CPython'?
docs/source/contribution/technical_steering_committee.md|1 col 3| [Kedro.headings] 'Kedro's Technical Steering Committee' should use sentence-style capitalization.
docs/source/contribution/technical_steering_committee.md|7 col 9| [Kedro.toowordy] 'is responsible for' is too wordy
docs/source/contribution/technical_steering_committee.md|38 col 63| [Kedro.toowordy] 'demonstrate' is too wordy
docs/source/contribution/technical_steering_committee.md|89 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/contribution/technical_steering_committee.md|119 col 166| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/contribution/technical_steering_committee.md|123 col 2| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/faq/faq.md|1 col 3| [Kedro.headings] 'FAQs' should use sentence-style capitalization.
docs/source/faq/faq.md|15 col 4| [Kedro.headings] 'Working with Jupyter' should use sentence-style capitalization.
docs/source/faq/faq.md|17 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|18 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|26 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|27 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|27 col 55| [Kedro.words] Use 'runtime' instead of 'run time'.
docs/source/faq/faq.md|28 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|28 col 35| [Kedro.words] Use 'runtime' instead of 'run time'.
docs/source/faq/faq.md|29 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|30 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|31 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|32 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|33 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|34 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|35 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|35 col 17| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/faq/faq.md|39 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|40 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|41 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|42 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|43 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|45 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|46 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|51 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|53 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|57 col 8| [Kedro.Spellings] Did you really mean 'Philp'?
docs/source/faq/faq.md|64 col 3| [Kedro.Spellings] Did you really mean 'data_engineering_convention'?
docs/source/faq/faq.md|68 col 224| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/faq/faq.md|69 col 99| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/faq/faq.md|72 col 114| [Kedro.toowordy] 'in the case of' is too wordy
docs/source/get_started/kedro_concepts.md|19 col 14| [Kedro.words] Use '' instead of 'simple'.
docs/source/get_started/kedro_concepts.md|60 col 86| [Kedro.toowordy] 'numerous' is too wordy
docs/source/get_started/kedro_concepts.md|64 col 140| [Kedro.oxfordcomma] Use the Oxford comma in 'Kedro uses semantic naming to set up a default project with specific folders to store datasets, notebooks, configuration and'.
docs/source/get_started/kedro_concepts.md|64 col 278| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/get_started/kedro_concepts.md|64 col 281| [Kedro.toowordy] 'advise' is too wordy
docs/source/get_started/kedro_concepts.md|64 col 295| [Kedro.toowordy] 'retain' is too wordy
docs/source/get_started/kedro_concepts.md|64 col 349| [Kedro.words] Use '' instead of 'easy'.
docs/source/get_started/kedro_concepts.md|82 col 32| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/get_started/kedro_concepts.md|86 col 16| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/get_started/kedro_concepts.md|96 col 13| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/get_started/kedro_concepts.md|98 col 17| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/get_started/kedro_concepts.md|104 col 28| [Kedro.toowordy] 'multiple' is too wordy
docs/source/get_started/kedro_concepts.md|104 col 37| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/get_started/kedro_concepts.md|104 col 145| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/get_started/kedro_concepts.md|108 col 6| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/get_started/new_project.md|19 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/get_started/new_project.md|19 col 28| [Kedro.words] Use '' instead of 'simple'.
docs/source/get_started/new_project.md|67 col 14| [Kedro.weaselwords] 'swiftly' is a weasel word!
docs/source/get_started/install.md|11 col 131| [Kedro.Spellings] Did you really mean 'CPython'?
docs/source/get_started/install.md|141 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/get_started/install.md|146 col 17| [Kedro.weaselwords] 'safely' is a weasel word!
docs/source/get_started/install.md|154 col 48| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/get_started/install.md|154 col 48| [Kedro.words] Use '' instead of 'simply'.
docs/source/notebooks_and_ipython/index.md|11 col 274| [Kedro.weaselwords] 'finally' is a weasel word!
docs/source/notebooks_and_ipython/index.md|13 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md|281 col 5| [Kedro.headings] 'Use Kedro's configuration loader to load "magic values"' should use sentence-style capitalization.
docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md|320 col 5| [Kedro.headings] 'Use Kedro's configuration loader to load the Data Catalog' should use sentence-style capitalization.
docs/source/nodes_and_pipelines/slice_a_pipeline.md|59 col 134| [Kedro.words] Use 'to' instead of 'in order to'.
docs/source/nodes_and_pipelines/slice_a_pipeline.md|59 col 134| [Kedro.toowordy] 'in order to' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|182 col 21| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|241 col 33| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/slice_a_pipeline.md|299 col 4| [Kedro.toowordy] 'demonstrate' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|313 col 27| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/nodes_and_pipelines/slice_a_pipeline.md|313 col 27| [Kedro.toowordy] 'previously' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|356 col 133| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/nodes_and_pipelines/run_a_pipeline.md|15 col 67| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.,'.
docs/source/nodes_and_pipelines/run_a_pipeline.md|33 col 9| [Kedro.weaselwords] 'alternatively' is a weasel word!
docs/source/nodes_and_pipelines/run_a_pipeline.md|33 col 9| [Kedro.toowordy] 'alternatively' is too wordy
docs/source/nodes_and_pipelines/run_a_pipeline.md|38 col 6| [Kedro.Spellings] Did you really mean 'Multithreading'?
docs/source/nodes_and_pipelines/run_a_pipeline.md|39 col 81| [Kedro.Spellings] Did you really mean 'multithreading'?
docs/source/nodes_and_pipelines/run_a_pipeline.md|141 col 15| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/run_a_pipeline.md|141 col 43| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.,'.
docs/source/nodes_and_pipelines/run_a_pipeline.md|192 col 4| [Kedro.headings] 'Run pipelines with IO' should use sentence-style capitalization.
docs/source/nodes_and_pipelines/run_a_pipeline.md|194 col 35| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/run_a_pipeline.md|194 col 130| [Kedro.oxfordcomma] Use the Oxford comma in 'In practice, we would like to interact with APIs, databases, files and'.
docs/source/nodes_and_pipelines/run_a_pipeline.md|200 col 6| [Kedro.words] Use '' instead of 'simple'.
docs/source/nodes_and_pipelines/run_a_pipeline.md|263 col 55| [Kedro.weaselwords] 'correctly' is a weasel word!
docs/source/nodes_and_pipelines/run_a_pipeline.md|283 col 1| [Kedro.weaselwords] 'Finally' is a weasel word!
docs/source/nodes_and_pipelines/run_a_pipeline.md|327 col 142| [Kedro.toowordy] 'alternatively' is too wordy
docs/source/nodes_and_pipelines/run_a_pipeline.md|327 col 142| [Kedro.weaselwords] 'alternatively' is a weasel word!
docs/source/nodes_and_pipelines/run_a_pipeline.md|356 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/run_a_pipeline.md|356 col 44| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|247 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|260 col 5| [Kedro.headings] 'IPython, JupyterLab and other Jupyter clients' should use sentence-style capitalization.
docs/source/nodes_and_pipelines/pipeline_introduction.md|3 col 4| [Kedro.toowordy] 'previously' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|3 col 4| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|5 col 4| [Kedro.toowordy] 'benefit from' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|9 col 42| [Kedro.words] Use '' instead of 'simple'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|9 col 199| [Kedro.weaselwords] 'usually' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|67 col 81| [Kedro.toowordy] 'all of' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|85 col 18| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|87 col 15| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|87 col 50| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|127 col 96| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|187 col 17| [Kedro.weaselwords] 'usually' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|214 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/pipeline_introduction.md|252 col 258| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/micro_packaging.md|3 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'Micro-packaging allows users to share Kedro micro-packages across codebases, organisations and'.
docs/source/nodes_and_pipelines/micro_packaging.md|34 col 227| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/micro_packaging.md|40 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/micro_packaging.md|40 col 237| [Kedro.toowordy] 'However' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|40 col 319| [Kedro.weaselwords] 'Simply' is a weasel word!
docs/source/nodes_and_pipelines/micro_packaging.md|42 col 1| [Kedro.toowordy] 'In addition' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|42 col 97| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/micro_packaging.md|44 col 12| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|46 col 12| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|83 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'You can pull a micro-package from different locations, including local storage, PyPI and'.
docs/source/nodes_and_pipelines/micro_packaging.md|107 col 9| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|109 col 11| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/pipeline_registry.md|3 col 470| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/pipeline_registry.md|3 col 940| [Kedro.toowordy] 'aforementioned' is too wordy
docs/source/nodes_and_pipelines/pipeline_registry.md|32 col 13| [Kedro.Spellings] Did you really mean 'autodiscovery'?
docs/source/nodes_and_pipelines/pipeline_registry.md|73 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/pipeline_registry.md|73 col 1| [Kedro.toowordy] 'On the other hand' is too wordy
docs/source/nodes_and_pipelines/nodes.md|5 col 139| [Kedro.words] Use '' instead of 'simple'.
docs/source/nodes_and_pipelines/nodes.md|20 col 110| [Kedro.words] Use '' instead of 'simple'.
docs/source/nodes_and_pipelines/nodes.md|76 col 32| [Kedro.toowordy] 'Multiple' is too wordy
docs/source/nodes_and_pipelines/nodes.md|90 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|92 col 220| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|103 col 49| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|103 col 49| [Kedro.words] Use '' instead of 'simply'.
docs/source/nodes_and_pipelines/nodes.md|122 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/nodes_and_pipelines/nodes.md|122 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|148 col 116| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|150 col 24| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|150 col 24| [Kedro.words] Use '' instead of 'simply'.
docs/source/nodes_and_pipelines/nodes.md|164 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|193 col 283| [Kedro.weaselwords] 'particularly' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|219 col 32| [Kedro.weaselwords] 'lazily' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|331 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/nodes.md|331 col 100| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/nodes.md|331 col 144| [Kedro.weaselwords] 'lazily' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|5 col 4| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|5 col 242| [Kedro.oxfordcomma] Use the Oxford comma in 'Modular pipelines are easier to develop, test and'.
docs/source/nodes_and_pipelines/modular_pipelines.md|7 col 54| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|7 col 207| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|24 col 48| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|25 col 52| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|33 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/nodes_and_pipelines/modular_pipelines.md|88 col 87| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|104 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/modular_pipelines.md|111 col 57| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|114 col 81| [Kedro.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
docs/source/nodes_and_pipelines/modular_pipelines.md|115 col 14| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|122 col 32| [Kedro.weaselwords] 'currently' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|126 col 14| [Kedro.weaselwords] 'really' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|128 col 58| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|129 col 24| [Kedro.toowordy] 'in terms of' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|129 col 59| [Kedro.toowordy] 'in terms of' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|130 col 88| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|144 col 22| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/modular_pipelines.md|195 col 29| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|197 col 306| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|199 col 104| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|199 col 136| [Kedro.weaselwords] 'currently' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|200 col 57| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|228 col 52| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|230 col 24| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|260 col 45| [Kedro.Spellings] Did you really mean 'breakfast_food'?
docs/source/nodes_and_pipelines/modular_pipelines.md|260 col 66| [Kedro.Spellings] Did you really mean 'lunch_food'?
docs/source/nodes_and_pipelines/modular_pipelines.md|269 col 56| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|278 col 30| [Kedro.weaselwords] 'very' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|278 col 30| [Kedro.words] Use '' instead of 'very'.
docs/source/nodes_and_pipelines/modular_pipelines.md|278 col 35| [Kedro.toowordy] 'similar to' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|323 col 3| [Kedro.Spellings] Did you really mean 'namespaced_params'?
docs/source/integrations/pyspark_integration.md|1 col 3| [Kedro.headings] 'PySpark integration' should use sentence-style capitalization.
docs/source/integrations/pyspark_integration.md|7 col 29| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/integrations/pyspark_integration.md|7 col 147| [Kedro.toowordy] 'all of' is too wordy
docs/source/integrations/pyspark_integration.md|51 col 12| [Kedro.toowordy] 'modify' is too wordy
docs/source/integrations/pyspark_integration.md|51 col 66| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/integrations/pyspark_integration.md|51 col 79| [Kedro.inclusive] Use 'primary' instead of 'master'.
docs/source/integrations/pyspark_integration.md|53 col 46| [Kedro.toowordy] 'obtain' is too wordy
docs/source/integrations/pyspark_integration.md|55 col 96| [Kedro.toowordy] 'therefore' is too wordy
docs/source/integrations/pyspark_integration.md|65 col 4| [Kedro.headings] 'Use Kedro's built-in Spark datasets to load and save raw data' should use sentence-style capitalization.
docs/source/integrations/pyspark_integration.md|67 col 189| [Kedro.toowordy] 'as to' is too wordy
docs/source/integrations/pyspark_integration.md|109 col 4| [Kedro.headings] 'Spark and Delta Lake interaction' should use sentence-style capitalization.
docs/source/integrations/pyspark_integration.md|111 col 83| [Kedro.Spellings] Did you really mean 'Lakehouse'?
docs/source/integrations/pyspark_integration.md|116 col 99| [Kedro.toowordy] 'type of' is too wordy
docs/source/integrations/pyspark_integration.md|146 col 119| [Kedro.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
docs/source/integrations/pyspark_integration.md|173 col 293| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/integrations/pyspark_integration.md|173 col 293| [Kedro.words] Use '' instead of 'simply'.
docs/source/integrations/pyspark_integration.md|198 col 197| [Kedro.Spellings] Did you really mean 'ML's'?
docs/source/integrations/pyspark_integration.md|245 col 64| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/integrations/pyspark_integration.md|245 col 263| [Kedro.toowordy] 'In order to' is too wordy
docs/source/integrations/pyspark_integration.md|251 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/integrations/pyspark_integration.md|251 col 105| [Kedro.weaselwords] 'roughly' is a weasel word!
docs/source/integrations/pyspark_integration.md|251 col 177| [Kedro.toowordy] 'therefore' is too wordy
docs/source/integrations/pyspark_integration.md|251 col 201| [Kedro.weaselwords] 'roughly' is a weasel word!
docs/source/integrations/pyspark_integration.md|251 col 398| [Kedro.toowordy] 'In order to' is too wordy
docs/source/deployment/single_machine.md|12 col 1| [Kedro.toowordy] 'For the purpose of' is too wordy
docs/source/deployment/single_machine.md|12 col 81| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/deployment/single_machine.md|39 col 151| [Kedro.toowordy] 'However' is too wordy
docs/source/deployment/single_machine.md|52 col 30| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/deployment/single_machine.md|52 col 126| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/deployment/single_machine.md|54 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'This means that you can distribute the project to run elsewhere, such as on a separate computer with different configuration, data and'.
docs/source/deployment/single_machine.md|54 col 272| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/deployment/single_machine.md|56 col 215| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/deployment/single_machine.md|68 col 4| [Kedro.headings] 'CLI-based' should use sentence-style capitalization.
docs/source/deployment/single_machine.md|69 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/deployment/single_machine.md|74 col 160| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 7 in docs/source/faq/faq.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/faq/faq.md#L7

[Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
Raw output
{"message": "[Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.", "location": {"path": "docs/source/faq/faq.md", "range": {"start": {"line": 7, "column": 11}}}, "severity": "WARNING"}

Check warning on line 9 in docs/source/faq/faq.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/faq/faq.md#L9

[Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
Raw output
{"message": "[Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.", "location": {"path": "docs/source/faq/faq.md", "range": {"start": {"line": 9, "column": 13}}}, "severity": "WARNING"}

Check warning on line 22 in docs/source/faq/faq.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/faq/faq.md#L22

[Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
Raw output
{"message": "[Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.", "location": {"path": "docs/source/faq/faq.md", "range": {"start": {"line": 22, "column": 11}}}, "severity": "WARNING"}

Check warning on line 22 in docs/source/faq/faq.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/faq/faq.md#L22

[Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
Raw output
{"message": "[Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.", "location": {"path": "docs/source/faq/faq.md", "range": {"start": {"line": 22, "column": 19}}}, "severity": "WARNING"}

Check warning on line 49 in docs/source/get_started/new_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/get_started/new_project.md#L49

[Kedro.words] Use 'after' instead of 'once'.
Raw output
{"message": "[Kedro.words] Use 'after' instead of 'once'.", "location": {"path": "docs/source/get_started/new_project.md", "range": {"start": {"line": 49, "column": 60}}}, "severity": "WARNING"}

Check warning on line 9 in docs/source/notebooks_and_ipython/kedro_and_notebooks.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/notebooks_and_ipython/kedro_and_notebooks.md#L9

[Kedro.words] Use '' instead of 'just'.
Raw output
{"message": "[Kedro.words] Use '' instead of 'just'.", "location": {"path": "docs/source/notebooks_and_ipython/kedro_and_notebooks.md", "range": {"start": {"line": 9, "column": 335}}}, "severity": "WARNING"}

Check warning on line 43 in docs/source/deployment/distributed.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/deployment/distributed.md#L43

[Kedro.weaselwords] 'regularly' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'regularly' is a weasel word!", "location": {"path": "docs/source/deployment/distributed.md", "range": {"start": {"line": 43, "column": 79}}}, "severity": "WARNING"}

Check notice on line 2 in docs/source/starters/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/index.md#L2

[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
Raw output
{"message": "[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.", "location": {"path": "docs/source/starters/index.md", "range": {"start": {"line": 2, "column": 1}}}, "severity": "INFO"}

Check warning on line 2 in docs/source/starters/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/index.md#L2

[Kedro.words] Use 'after' instead of 'once'.
Raw output
{"message": "[Kedro.words] Use 'after' instead of 'once'.", "location": {"path": "docs/source/starters/index.md", "range": {"start": {"line": 2, "column": 75}}}, "severity": "WARNING"}

Check notice on line 14 in docs/source/starters/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/index.md#L14

[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
Raw output
{"message": "[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.", "location": {"path": "docs/source/starters/index.md", "range": {"start": {"line": 14, "column": 3}}}, "severity": "INFO"}

Check warning on line 18 in docs/source/starters/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/index.md#L18

[Kedro.weaselwords] 'additionally' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'additionally' is a weasel word!", "location": {"path": "docs/source/starters/index.md", "range": {"start": {"line": 18, "column": 40}}}, "severity": "WARNING"}

Check warning on line 43 in docs/source/starters/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/index.md#L43

[Kedro.weaselwords] 'Alternatively' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'Alternatively' is a weasel word!", "location": {"path": "docs/source/starters/index.md", "range": {"start": {"line": 43, "column": 1}}}, "severity": "WARNING"}

Check warning on line 43 in docs/source/starters/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/index.md#L43

[Kedro.toowordy] 'Alternatively' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'Alternatively' is too wordy", "location": {"path": "docs/source/starters/index.md", "range": {"start": {"line": 43, "column": 1}}}, "severity": "WARNING"}

Check warning on line 55 in docs/source/starters/starters.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/starters.md#L55

[Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
Raw output
{"message": "[Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.", "location": {"path": "docs/source/starters/starters.md", "range": {"start": {"line": 55, "column": 43}}}, "severity": "WARNING"}

Check warning on line 38 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L38

[Kedro.words] Use '' instead of 'very'.
Raw output
{"message": "[Kedro.words] Use '' instead of 'very'.", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 38, "column": 8}}}, "severity": "WARNING"}

Check warning on line 38 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L38

[Kedro.weaselwords] 'very' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'very' is a weasel word!", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 38, "column": 8}}}, "severity": "WARNING"}

Check warning on line 40 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L40

[Kedro.weaselwords] 'only' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'only' is a weasel word!", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 40, "column": 80}}}, "severity": "WARNING"}

Check warning on line 40 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L40

[Kedro.words] Use 'with' or 'through' instead of 'via'.
Raw output
{"message": "[Kedro.words] Use 'with' or 'through' instead of 'via'.", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 40, "column": 149}}}, "severity": "WARNING"}

Check warning on line 40 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L40

[Kedro.Spellings] Did you really mean 'cookiecutter'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'cookiecutter'?", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 40, "column": 196}}}, "severity": "WARNING"}

Check warning on line 62 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L62

[Kedro.Spellings] Did you really mean 'subfolder'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'subfolder'?", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 62, "column": 44}}}, "severity": "WARNING"}

Check warning on line 119 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L119

[Kedro.toowordy] 'multiple' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'multiple' is too wordy", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 119, "column": 71}}}, "severity": "WARNING"}

Check warning on line 119 in docs/source/starters/create_a_starter.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/starters/create_a_starter.md#L119

[Kedro.weaselwords] 'only' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'only' is a weasel word!", "location": {"path": "docs/source/starters/create_a_starter.md", "range": {"start": {"line": 119, "column": 198}}}, "severity": "WARNING"}