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

Update docs on installing development requirements #4178

Merged
merged 8 commits into from
Sep 23, 2024

Merge branch 'main' into docs/2519-dev-requirements

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

Update docs on installing development requirements #4178

Merge branch 'main' into docs/2519-dev-requirements
7a1ce98
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Sep 23, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (2)

docs/source/development/automated_testing.md|42 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/development/automated_testing.md|42 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!

Filtered Findings (1681)

.github/PULL_REQUEST_TEMPLATE.md|8 col 4| [Kedro.headings] 'Developer Certificate of Origin' should use sentence-style capitalization.
.github/PULL_REQUEST_TEMPLATE.md|9 col 30| [Kedro.toowordy] 'comply with' is too wordy
.github/PULL_REQUEST_TEMPLATE.md|11 col 93| [Kedro.Spellings] Did you really mean 'Rebase'?
.github/PULL_REQUEST_TEMPLATE.md|20 col 28| [Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
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
.github/ISSUE_TEMPLATE/feature-request.md|16 col 4| [Kedro.headings] 'Possible Implementation' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/feature-request.md|19 col 4| [Kedro.headings] 'Possible Alternatives' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|16 col 4| [Kedro.headings] 'Steps to Reproduce' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|21 col 4| [Kedro.headings] 'Expected Result' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|24 col 4| [Kedro.headings] 'Actual Result' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/bug-report.md|35 col 4| [Kedro.headings] 'Your Environment' should use sentence-style capitalization.
.github/ISSUE_TEMPLATE/software_design_proposal.md|32 col 4| [Kedro.Spellings] Did you really mean 'Rollout'?
[features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md#L1) [Kedro.headings] 'Data Science pipeline' should use sentence-style capitalization.
[features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md|3 col 123|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md#L3) [Kedro.toowordy] 'modify' is too wordy
[features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md|8 col 13|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md#L8) [Kedro.words] Use '' instead of 'simple'.
README.md|19 col 4| [Kedro.weaselwords] 'Monthly' is a weasel word!
README.md|30 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|56 col 53| [Kedro.words] Use '' instead of 'easy'.
README.md|57 col 100| [Kedro.weaselwords] 'many' is a weasel word!
README.md|62 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|81 col 140| [Kedro.Spellings] Did you really mean 'unvetted'?
README.md|93 col 129| [Kedro.words] Use 'few', 'several', or 'many' instead of 'a number of'.
README.md|93 col 129| [Kedro.toowordy] 'a number of' is too wordy
README.md|95 col 4| [Kedro.headings] 'Can I contribute?' should use sentence-style capitalization.
README.md|95 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|99 col 14| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|103 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
README.md|105 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|110 col 131| [Kedro.Spellings] Did you really mean 'CPython'?
[features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md|5 col 149|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md#L5) [Kedro.toowordy] 'however' is too wordy
[features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md|5 col 187|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md#L5) [Kedro.toowordy] 'retain' is too wordy
[features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md|9 col 83|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md#L9) [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
[features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md|9 col 121|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md#L9) [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
[features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_engineering/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_engineering/README.md#L1) [Kedro.headings] 'Data Engineering pipeline' should use sentence-style capitalization.
[features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_engineering/README.md|3 col 123|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_engineering/README.md#L3) [Kedro.toowordy] 'modify' is too wordy
[kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md|5 col 149|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md#L5) [Kedro.toowordy] 'however' is too wordy
[kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md|5 col 187|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md#L5) [Kedro.toowordy] 'retain' is too wordy
[kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md|9 col 83|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md#L9) [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
[kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md|9 col 121|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md#L9) [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
SECURITY.md|3 col 44| [Kedro.weaselwords] 'seriously' is a weasel word!
[features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md#L1) [Kedro.headings] '{{ cookiecutter.project_name }}' should use sentence-style capitalization.
[features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md|11 col 1|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md#L11) [Kedro.toowordy] 'In order to' is too wordy
[features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md|70 col 5|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md#L70) [Kedro.headings] 'JupyterLab' should use sentence-style capitalization.
CONTRIBUTING.md|3 col 93| [Kedro.weaselwords] 'few' is a weasel word!
CONTRIBUTING.md|9 col 164| [Kedro.words] Use '' instead of 'simply'.
CONTRIBUTING.md|9 col 164| [Kedro.weaselwords] 'simply' is a weasel word!
CONTRIBUTING.md|13 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
CONTRIBUTING.md|13 col 19| [Kedro.weaselwords] 'few' is a weasel word!
CONTRIBUTING.md|17 col 4| [Kedro.headings] 'Join the Technical Steering Committee' should use sentence-style capitalization.
CONTRIBUTING.md|22 col 4| [Kedro.weaselwords] 'regularly' is a weasel word!
CONTRIBUTING.md|26 col 138| [Kedro.Spellings] Did you really mean 'Kedroid'?
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L1) [Kedro.headings] '{{ cookiecutter.project_name }}' should use sentence-style capitalization.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|11 col 1|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L11) [Kedro.toowordy] 'In order to' is too wordy
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|57 col 3|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L57) [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|57 col 100|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L57) [Kedro.words] Use 'after' instead of 'once'.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|72 col 5|](https://github.com/kedro-org/kedro/blob/7a1ce98cb348a458130fc8778eaa7008874fa011/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L72) [Kedro.headings] 'JupyterLab' should use sentence-style capitalization.
LICENSE.md|9 col 17| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|12 col 8| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|12 col 18| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|12 col 59| [Kedro.ukspelling] In general, use UK English spelling instead of 'authorized'.
LICENSE.md|15 col 22| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|17 col 33| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|23 col 25| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|26 col 21| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|30 col 8| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|30 col 21| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|35 col 8| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|35 col 14| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|40 col 8| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|40 col 26| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|43 col 62| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|44 col 41| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|48 col 8| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|48 col 22| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|51 col 20| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|52 col 43| [Kedro.ukspelling] In general, use UK English spelling instead of 'authorized'.
LICENSE.md|53 col 28| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|55 col 14| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|58 col 7| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|58 col 16| [Kedro.toowordy] 'for the purpose of' is too wordy
LICENSE.md|62 col 21| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|62 col 32| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|63 col 61| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|70 col 43| [Kedro.Spellings] Did you really mean 'sublicense'?
LICENSE.md|78 col 34| [Kedro.weaselwords] 'only' is a weasel word!
LICENSE.md|84 col 54| [Kedro.toowordy] 'constitutes' is too wordy
LICENSE.md|86 col 55| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|86 col 61| [Kedro.toowordy] 'terminate' is too wordy
LICENSE.md|91 col 52| [Kedro.toowordy] 'provided that' is too wordy
LICENSE.md|100 col 8| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|100 col 20| [Kedro.toowordy] 'retain' is too wordy
LICENSE.md|106 col 8| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|107 col 56| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|115 col 45| [Kedro.weaselwords] 'normally' is a weasel word!
LICENSE.md|116 col 61| [Kedro.weaselwords] 'only' is a weasel word!
LICENSE.md|117 col 18| [Kedro.toowordy] 'modify' is too wordy
LICENSE.md|123 col 7| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
LICENSE.md|132 col 30| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|134 col 7| [Kedro.toowordy] 'Notwithstanding' is too wordy
LICENSE.md|134 col 49| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|134 col 68| [Kedro.toowordy] 'modify' is too wordy
LICENSE.md|136 col 12| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|136 col 21| [Kedro.toowordy] 'regarding' is too wordy
LICENSE.md|139 col 65| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|144 col 29| [Kedro.Spellings] Did you really mean 'Licensor'?
LICENSE.md|156 col 48| [Kedro.toowordy] 'shall' is too wordy
LICENSE.md|168 col 38| [Kedro.words] Use 'and', 'or', or 'either or' instead of 'and/or'.
LICENSE.md|169 col 16| [Kedro.toowordy] 'However' is too wordy
LICENSE.md|169 col 68| [Kedro.weaselwords] 'only' is a weasel word!
LICENSE.md|171 col 37| [Kedro.weaselwords] 'only' is a weasel word!
LICENSE.md|189 col 15| [Kedro.Spellings] Did you really mean 'yyyy'?
LICENSE.md|193 col 12| [Kedro.toowordy] 'obtain' is too wordy
LICENSE.md|197 col 4| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/slice_a_pipeline.md|66 col 134| [Kedro.words] Use 'to' instead of 'in order to'.
docs/source/nodes_and_pipelines/slice_a_pipeline.md|66 col 134| [Kedro.toowordy] 'in order to' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|189 col 21| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|248 col 33| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/slice_a_pipeline.md|306 col 4| [Kedro.toowordy] 'demonstrate' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|320 col 27| [Kedro.toowordy] 'previously' is too wordy
docs/source/nodes_and_pipelines/slice_a_pipeline.md|320 col 27| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/nodes_and_pipelines/slice_a_pipeline.md|363 col 133| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/nodes_and_pipelines/micro_packaging.md|7 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|38 col 227| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/micro_packaging.md|44 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/micro_packaging.md|44 col 237| [Kedro.toowordy] 'However' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|44 col 319| [Kedro.weaselwords] 'Simply' is a weasel word!
docs/source/nodes_and_pipelines/micro_packaging.md|46 col 1| [Kedro.toowordy] 'In addition' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|46 col 97| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/micro_packaging.md|48 col 12| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|50 col 12| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|87 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|111 col 9| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/micro_packaging.md|113 col 11| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|5 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/namespaces.md|17 col 27| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|17 col 176| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/namespaces.md|56 col 79| [Kedro.Spellings] Did you really mean 'ovewrite'?
docs/source/nodes_and_pipelines/namespaces.md|71 col 173| [Kedro.toowordy] 'However' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|71 col 304| [Kedro.toowordy] 'on the other hand' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|71 col 378| [Kedro.Spellings] Did you really mean 'autodiscovered'?
docs/source/nodes_and_pipelines/namespaces.md|71 col 406| [Kedro.toowordy] 'it was' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|73 col 113| [Kedro.weaselwords] 'few' is a weasel word!
docs/source/nodes_and_pipelines/namespaces.md|73 col 141| [Kedro.toowordy] 'modify' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|87 col 18| [Kedro.toowordy] 'modify' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|103 col 148| [Kedro.toowordy] 'modify' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|117 col 252| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/namespaces.md|117 col 311| [Kedro.toowordy] 'it was' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|117 col 318| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/nodes_and_pipelines/namespaces.md|117 col 318| [Kedro.toowordy] 'previously' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|125 col 76| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/nodes_and_pipelines/namespaces.md|133 col 14| [Kedro.Spellings] Did you really mean 'uncollapsed'?
docs/source/nodes_and_pipelines/namespaces.md|135 col 61| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/namespaces.md|139 col 66| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/namespaces.md|146 col 1| [Kedro.toowordy] 'Modify' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|152 col 1| [Kedro.toowordy] 'Modify' is too wordy
docs/source/nodes_and_pipelines/namespaces.md|152 col 86| [Kedro.toowordy] 'it was' is too wordy
docs/source/nodes_and_pipelines/pipeline_registry.md|3 col 449| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/pipeline_registry.md|3 col 919| [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|56 col 57| [Kedro.Spellings] Did you really mean 'autodiscovery'?
docs/source/nodes_and_pipelines/pipeline_registry.md|56 col 201| [Kedro.weaselwords] 'accidentally' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_registry.md|75 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/pipeline_registry.md|75 col 1| [Kedro.toowordy] 'On the other hand' 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|3 col 4| [Kedro.toowordy] 'previously' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|5 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
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|11 col 17| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|16 col 36| [Kedro.Spellings] Did you really mean 'kedro'?
docs/source/nodes_and_pipelines/pipeline_introduction.md|25 col 42| [Kedro.words] Use '' instead of 'simple'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|25 col 199| [Kedro.weaselwords] 'usually' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|53 col 53| [Kedro.Spellings] Did you really mean 'mean_sos'?
docs/source/nodes_and_pipelines/pipeline_introduction.md|56 col 69| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|83 col 17| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|85 col 15| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|85 col 50| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|120 col 96| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|177 col 81| [Kedro.toowordy] 'all of' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|196 col 17| [Kedro.weaselwords] 'usually' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|220 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/pipeline_introduction.md|257 col 36| [Kedro.Spellings] Did you really mean 'kedro'?
docs/source/nodes_and_pipelines/pipeline_introduction.md|259 col 149| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|259 col 343| [Kedro.words] Use '' instead of 'easy'.
docs/source/nodes_and_pipelines/pipeline_introduction.md|259 col 382| [Kedro.weaselwords] 'Simply' is a weasel word!
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.toowordy] 'alternatively' is too wordy
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|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.weaselwords] 'alternatively' 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|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/nodes_and_pipelines/modular_pipelines.md|3 col 4| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|3 col 339| [Kedro.words] Use '' instead of 'easy'.
docs/source/nodes_and_pipelines/modular_pipelines.md|3 col 391| [Kedro.weaselwords] 'Simply' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|61 col 215| [Kedro.Spellings] Did you really mean 'kedro'?
docs/source/nodes_and_pipelines/modular_pipelines.md|101 col 6| [Kedro.toowordy] 'it was' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|101 col 56| [Kedro.weaselwords] 'few' is a weasel word!
docs/source/nodes_and_pipelines/modular_pipelines.md|115 col 87| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|123 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/modular_pipelines.md|130 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/modular_pipelines.md|150 col 49| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/nodes_and_pipelines/modular_pipelines.md|152 col 59| [Kedro.toowordy] 'in terms of' is too wordy
docs/source/nodes_and_pipelines/modular_pipelines.md|152 col 136| [Kedro.words] Use '' instead of 'easy'.
docs/source/nodes_and_pipelines/modular_pipelines.md|154 col 73| [Kedro.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
docs/source/nodes_and_pipelines/modular_pipelines.md|155 col 14| [Kedro.weaselwords] 'only' 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|33 col 1| [Kedro.weaselwords] 'Additionally' is a weasel word!
docs/source/starters/index.md|36 col 23| [Kedro.toowordy] 'Indicate' is too wordy
docs/source/starters/starters.md|59 col 43| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
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|92 col 103| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/nodes.md|92 col 112| [Kedro.Spellings] Did you really mean 'dataframes'?
docs/source/nodes_and_pipelines/nodes.md|92 col 185| [Kedro.words] Use '' instead of 'simply'.
docs/source/nodes_and_pipelines/nodes.md|92 col 185| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|94 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|96 col 220| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|107 col 49| [Kedro.words] Use '' instead of 'simply'.
docs/source/nodes_and_pipelines/nodes.md|107 col 49| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|126 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|126 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/nodes_and_pipelines/nodes.md|152 col 116| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|154 col 24| [Kedro.words] Use '' instead of 'simply'.
docs/source/nodes_and_pipelines/nodes.md|154 col 24| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|168 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|200 col 283| [Kedro.weaselwords] 'particularly' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|226 col 32| [Kedro.weaselwords] 'lazily' is a weasel word!
docs/source/nodes_and_pipelines/nodes.md|338 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/nodes.md|338 col 100| [Kedro.toowordy] 'multiple' is too wordy
docs/source/nodes_and_pipelines/nodes.md|338 col 144| [Kedro.weaselwords] 'lazily' is a weasel word!
docs/source/starters/create_a_starter.md|40 col 8| [Kedro.words] Use '' instead of 'very'.
docs/source/starters/create_a_starter.md|40 col 8| [Kedro.weaselwords] 'very' is a weasel word!
docs/source/starters/create_a_starter.md|42 col 80| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/starters/create_a_starter.md|42 col 149| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/starters/create_a_starter.md|42 col 196| [Kedro.Spellings] Did you really mean 'cookiecutter'?
docs/source/starters/create_a_starter.md|64 col 44| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/starters/create_a_starter.md|121 col 71| [Kedro.toowordy] 'multiple' is too wordy
docs/source/starters/create_a_starter.md|121 col 198| [Kedro.weaselwords] 'only' is a weasel word!
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|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.words] Use '' instead of 'simply'.
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 42 in docs/source/development/automated_testing.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/development/automated_testing.md#L42

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

Check warning on line 42 in docs/source/development/automated_testing.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/development/automated_testing.md#L42

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