Add documentation about correct usage of configure_project
#2728
reviewdog [vale] report
reported by reviewdog 🐶
Findings (2)
docs/source/kedro_project_setup/session.md|67 col 6| [Kedro.headings] 'ValueError: Package name not found' should use sentence-style capitalization.
docs/source/kedro_project_setup/session.md|68 col 88| [Kedro.Spellings] Did you really mean 'bootstrap_project'?
Filtered Findings (1662)
.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'.
.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.
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'?
SECURITY.md|3 col 44| [Kedro.weaselwords] 'seriously' is a weasel word!
.github/ISSUE_TEMPLATE/software_design_proposal.md|32 col 4| [Kedro.Spellings] Did you really mean 'Rollout'?
.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.
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|50 col 53| [Kedro.words] Use '' instead of 'easy'.
README.md|51 col 100| [Kedro.weaselwords] 'many' is a weasel word!
README.md|56 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|75 col 140| [Kedro.Spellings] Did you really mean 'unvetted'?
README.md|87 col 129| [Kedro.words] Use 'few', 'several', or 'many' instead of 'a number of'.
README.md|87 col 129| [Kedro.toowordy] 'a number of' is too wordy
README.md|89 col 4| [Kedro.headings] 'Can I contribute?' should use sentence-style capitalization.
README.md|89 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|93 col 14| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|97 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
README.md|99 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|104 col 131| [Kedro.Spellings] Did you really mean 'CPython'?
docs/source/kedro_project_setup/settings.md|11 col 132| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/kedro_project_setup/dependencies.md|26 col 1| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/kedro_project_setup/dependencies.md|26 col 35| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/kedro_project_setup/session.md|8 col 3| [Kedro.Spellings] Did you really mean 'Traceback'?
docs/source/kedro_project_setup/session.md|36 col 22| [Kedro.Spellings] Did you really mean 'boolean'?
docs/source/kedro_project_setup/session.md|36 col 39| [Kedro.toowordy] 'indicate' is too wordy
docs/source/kedro_project_setup/session.md|36 col 48| [Kedro.toowordy] 'whether or not' is too wordy
docs/source/kedro_project_setup/session.md|39 col 76| [Kedro.toowordy] 'therefore' is too wordy
docs/source/kedro_project_setup/session.md|45 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/kedro_project_setup/session.md|47 col 4| [Kedro.Spellings] Did you really mean 'subgraph'?
docs/source/kedro_project_setup/session.md|50 col 8| [Kedro.ukspelling] In general, use UK English spelling instead of 'Initialize'.
docs/source/kedro_project_setup/session.md|57 col 169| [Kedro.Spellings] Did you really mean 'programatically'?
docs/source/kedro_project_setup/session.md|57 col 359| [Kedro.weaselwords] 'Only' is a weasel word!
docs/source/kedro_project_setup/session.md|61 col 45| [Kedro.weaselwords] 'additionally' is a weasel word!
docs/source/kedro_project_setup/session.md|65 col 163| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/tutorial/spaceflights_tutorial.md|1 col 3| [Kedro.headings] 'Next steps: Tutorial' should use sentence-style capitalization.
docs/source/tutorial/spaceflights_tutorial.md|5 col 20| [Kedro.weaselwords] 'approximately' is a weasel word!
docs/source/tutorial/spaceflights_tutorial.md|26 col 118| [Kedro.Spellings] Did you really mean 'Unsplash'?
docs/source/tutorial/tutorial_template.md|78 col 49| [Kedro.words] Use '' instead of 'easily'.
docs/source/tutorial/tutorial_template.md|78 col 49| [Kedro.weaselwords] 'easily' is a weasel word!
docs/source/tutorial/tutorial_template.md|79 col 45| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/tutorial/spaceflights_tutorial_faqs.md|1 col 3| [Kedro.headings] 'Spaceflights tutorial FAQs' should use sentence-style capitalization.
docs/source/tutorial/spaceflights_tutorial_faqs.md|7 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/tutorial/spaceflights_tutorial_faqs.md|10 col 6| [Kedro.headings] 'DatasetError: Failed while loading data from data set' should use sentence-style capitalization.
docs/source/tutorial/spaceflights_tutorial_faqs.md|10 col 51| [Kedro.words] Use 'dataset' instead of 'data set'.
docs/source/tutorial/spaceflights_tutorial_faqs.md|23 col 6| [Kedro.headings] 'DatasetNotFoundError: Dataset not found in the catalog' should use sentence-style capitalization.
docs/source/tutorial/spaceflights_tutorial_faqs.md|37 col 6| [Kedro.headings] 'DatasetError: An exception occurred when parsing config for Dataset' should use sentence-style capitalization.
docs/source/tutorial/spaceflights_tutorial_faqs.md|53 col 4| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/tutorial/spaceflights_tutorial_faqs.md|53 col 114| [Kedro.toowordy] 'similar to' is too wordy
docs/source/tutorial/set_up_data.md|21 col 3| [Kedro.toowordy] 'Type of' is too wordy
docs/source/tutorial/set_up_data.md|54 col 234| [Kedro.toowordy] 'equivalent' is too wordy
docs/source/tutorial/set_up_data.md|71 col 196| [Kedro.Spellings] Did you really mean 'filepath'?
docs/source/tutorial/set_up_data.md|134 col 179| [Kedro.toowordy] 'all of' is too wordy
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/tutorial/package_a_project.md|5 col 161| [Kedro.words] Use '' instead of 'please'.
docs/source/tutorial/package_a_project.md|38 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/tutorial/package_a_project.md|40 col 5| [Kedro.headings] 'Build HTML documentation' should use sentence-style capitalization.
docs/source/tutorial/package_a_project.md|56 col 24| [Kedro.Spellings] Did you really mean 'docstrings'?
docs/source/tutorial/package_a_project.md|57 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/tutorial/package_a_project.md|66 col 1| [Kedro.weaselwords] 'Finally' is a weasel word!
docs/source/tutorial/package_a_project.md|66 col 41| [Kedro.Spellings] Did you really mean 'autodoc'?
docs/source/tutorial/package_a_project.md|66 col 97| [Kedro.words] Use 'after' instead of 'once'.
docs/source/tutorial/package_a_project.md|73 col 103| [Kedro.Spellings] Did you really mean 'docstrings'?
docs/source/tutorial/package_a_project.md|87 col 1| [Kedro.weaselwords] 'Finally' is a weasel word!
docs/source/tutorial/package_a_project.md|87 col 120| [Kedro.Spellings] Did you really mean 'docstrings'?
docs/source/tutorial/package_a_project.md|107 col 31| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/tutorial/package_a_project.md|107 col 123| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/tutorial/package_a_project.md|107 col 135| [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 information, dataset and'.
docs/source/tutorial/package_a_project.md|133 col 180| [Kedro.toowordy] 'modify' is too wordy
docs/source/tutorial/package_a_project.md|145 col 9| [Kedro.toowordy] 'equivalent' is too wordy
docs/source/tutorial/package_a_project.md|149 col 56| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/tutorial/test_a_project.md|3 col 47| [Kedro.toowordy] 'validate' is too wordy
docs/source/tutorial/test_a_project.md|15 col 124| [Kedro.Spellings] Did you really mean 'parameterising'?
docs/source/tutorial/test_a_project.md|47 col 195| [Kedro.Spellings] Did you really mean 'pytest's'?
docs/source/tutorial/test_a_project.md|53 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/tutorial/test_a_project.md|53 col 129| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/tutorial/test_a_project.md|101 col 215| [Kedro.weaselwords] 'equally' is a weasel word!
docs/source/tutorial/test_a_project.md|103 col 67| [Kedro.toowordy] 'validate' is too wordy
docs/source/tutorial/test_a_project.md|145 col 94| [Kedro.toowordy] 'However' is too wordy
docs/source/tutorial/test_a_project.md|183 col 154| [Kedro.toowordy] 'evaluate' is too wordy
docs/source/tutorial/test_a_project.md|183 col 216| [Kedro.toowordy] 'validate' is too wordy
docs/source/tutorial/test_a_project.md|185 col 158| [Kedro.toowordy] 'validate' is too wordy
docs/source/tutorial/test_a_project.md|185 col 216| [Kedro.Spellings] Did you really mean 'pytest's'?
docs/source/tutorial/test_a_project.md|279 col 103| [Kedro.weaselwords] 'mostly' is a weasel word!
docs/source/tutorial/test_a_project.md|321 col 80| [Kedro.weaselwords] 'currently' is a weasel word!
docs/source/tutorial/test_a_project.md|321 col 110| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/tutorial/test_a_project.md|321 col 124| [Kedro.toowordy] 'However' is too wordy
docs/source/tutorial/test_a_project.md|446 col 42| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/tutorial/add_another_pipeline.md|6 col 37| [Kedro.words] Use '' instead of 'just'.
docs/source/tutorial/add_another_pipeline.md|175 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/tutorial/add_another_pipeline.md|181 col 23| [Kedro.toowordy] 'similar to' is too wordy
docs/source/tutorial/add_another_pipeline.md|233 col 72| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/tutorial/add_another_pipeline.md|238 col 45| [Kedro.words] Use '' instead of 'just'.
docs/source/tutorial/add_another_pipeline.md|238 col 144| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/tutorial/add_another_pipeline.md|238 col 189| [Kedro.Spellings] Did you really mean 'hyperparameters'?
docs/source/tutorial/add_another_pipeline.md|240 col 42| [Kedro.words] Use '' instead of 'just'.
docs/source/tutorial/add_another_pipeline.md|240 col 51| [Kedro.toowordy] 'portion' is too wordy
docs/source/tutorial/add_another_pipeline.md|240 col 125| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/tutorial/add_another_pipeline.md|250 col 4| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/tutorial/add_another_pipeline.md|250 col 328| [Kedro.toowordy] 'multiple' is too wordy
docs/source/tutorial/add_another_pipeline.md|252 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'Modular pipelines are easier to develop, test and'.
docs/source/tutorial/add_another_pipeline.md|252 col 138| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/tutorial/add_another_pipeline.md|254 col 39| [Kedro.Spellings] Did you really mean 'namespacing'?
docs/source/tutorial/add_another_pipeline.md|257 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/tutorial/add_another_pipeline.md|444 col 100| [Kedro.toowordy] 'multiple' is too wordy
docs/source/tutorial/add_another_pipeline.md|483 col 27| [Kedro.Spellings] Did you really mean 'template_pipeline'?
docs/source/tutorial/add_another_pipeline.md|499 col 1| [Kedro.toowordy] 'However' is too wordy
docs/source/tutorial/add_another_pipeline.md|503 col 3| [Kedro.Spellings] Did you really mean 'modular_ds'?
docs/source/tutorial/add_another_pipeline.md|509 col 49| [Kedro.words] Use 'after' instead of 'once'.
docs/source/tutorial/add_another_pipeline.md|510 col 212| [Kedro.toowordy] 'multiple' is too wordy
docs/source/tutorial/add_another_pipeline.md|511 col 84| [Kedro.Spellings] Did you really mean 'multithreading'?
docs/source/tutorial/add_another_pipeline.md|521 col 32| [Kedro.Spellings] Did you really mean 'parallelisation'?
docs/source/tutorial/add_another_pipeline.md|521 col 48| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/development/set_up_vscode.md|1 col 3| [Kedro.headings] 'Set up Visual Studio Code' should use sentence-style capitalization.
docs/source/development/set_up_vscode.md|13 col 4| [Kedro.headings] 'Kedro VS Code Extension' should use sentence-style capitalization.
docs/source/development/set_up_vscode.md|16 col 17| [Kedro.Spellings] Did you really mean 'gif'?
docs/source/development/set_up_vscode.md|25 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/development/set_up_vscode.md|30 col 110| [Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/development/set_up_vscode.md|42 col 28| [Kedro.toowordy] 'modify' is too wordy
docs/source/development/set_up_vscode.md|42 col 159| [Kedro.toowordy] 'Modify' is too wordy
docs/source/development/set_up_vscode.md|146 col 10| [Kedro.Spellings] Did you really mean 'breakpoint'?
docs/source/development/set_up_vscode.md|158 col 30| [Kedro.Spellings] Did you really mean 'breakpoint'?
docs/source/development/set_up_vscode.md|162 col 5| [Kedro.headings] 'Advanced: Remote interpreter debugging' should use sentence-style capitalization.
docs/source/development/set_up_vscode.md|250 col 17| [Kedro.Spellings] Did you really mean 'breakpoint'?
docs/source/development/set_up_vscode.md|256 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/development/set_up_vscode.md|256 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'You can enable the Kedro catalog validation schema in your VS Code to enable real-time validation, autocompletion and'.
docs/source/tutorial/create_a_pipeline.md|34 col 22| [Kedro.Spellings] Did you really mean 'preprocess'?
docs/source/tutorial/create_a_pipeline.md|129 col 1| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/tutorial/create_a_pipeline.md|129 col 66| [Kedro.words] Use 'see', 'read', or 'follow' instead of 'refer to'.
docs/source/tutorial/create_a_pipeline.md|129 col 267| [Kedro.Spellings] Did you really mean 'interdependencies'?
docs/source/tutorial/create_a_pipeline.md|140 col 23| [Kedro.toowordy] 'similar to' is too wordy
docs/source/tutorial/create_a_pipeline.md|169 col 23| [Kedro.toowordy] 'similar to' is too wordy
docs/source/tutorial/create_a_pipeline.md|211 col 77| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/tutorial/create_a_pipeline.md|304 col 23| [Kedro.toowordy] 'similar to' is too wordy
docs/source/tutorial/create_a_pipeline.md|366 col 109| [Kedro.Spellings] Did you really mean 'Unsplash'?
docs/source/development/automated_testing.md|7 col 46| [Kedro.toowordy] 'all of' is too wordy
docs/source/development/automated_testing.md|8 col 109| [Kedro.toowordy] 'all of' is too wordy
docs/source/development/automated_testing.md|10 col 87| [Kedro.Spellings] Did you really mean 'interdependencies'?
docs/source/development/automated_testing.md|10 col 159| [Kedro.weaselwords] 'unexpectedly' is a weasel word!
docs/source/development/automated_testing.md|12 col 89| [Kedro.weaselwords] 'usually' is a weasel word!
docs/source/development/automated_testing.md|12 col 101| [Kedro.words] Use 'after' instead of 'once'.
docs/source/development/automated_testing.md|14 col 77| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/development/automated_testing.md|18 col 11| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/development/automated_testing.md|18 col 165| [Kedro.words] Use '' instead of 'quick'.
docs/source/development/automated_testing.md|73 col 136| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/development/automated_testing.md|73 col 136| [Kedro.words] Use '' instead of 'simply'.
docs/source/development/automated_testing.md|73 col 159| [Kedro.Spellings] Did you really mean 'project_path'?
docs/source/development/automated_testing.md|73 col 236| [Kedro.weaselwords] 'correctly' is a weasel word!
docs/source/development/automated_testing.md|101 col 45| [Kedro.weaselwords] 'few' is a weasel word!
docs/source/development/automated_testing.md|106 col 53| [Kedro.weaselwords] 'especially' is a weasel word!
docs/source/development/automated_testing.md|108 col 182| [Kedro.toowordy] 'all of' is too wordy
docs/source/development/automated_testing.md|132 col 41| [Kedro.weaselwords] 'successfully' is a weasel word!
docs/source/development/automated_testing.md|179 col 49| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/development/automated_testing.md|179 col 109| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/faq/faq.md|1 col 3| [Kedro.headings] 'FAQs' should use sentence-style capitalization.
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|15 col 4| [Kedro.headings] 'Working with Notebooks' 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|19 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|24 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|24 col 19| [Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
docs/source/faq/faq.md|28 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|29 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|29 col 55| [Kedro.words] Use 'runtime' instead of 'run time'.
docs/source/faq/faq.md|30 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|30 col 35| [Kedro.words] Use 'runtime' instead of 'run time'.
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|36 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|37 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|37 col 17| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/faq/faq.md|38 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|44 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|48 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|49 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|50 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|55 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|56 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|56 col 20| [Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
docs/source/faq/faq.md|57 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|61 col 8| [Kedro.Spellings] Did you really mean 'Philp'?
docs/source/faq/faq.md|68 col 3| [Kedro.Spellings] Did you really mean 'data_engineering_convention'?
docs/source/faq/faq.md|72 col 224| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/faq/faq.md|73 col 99| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/faq/faq.md|76 col 114| [Kedro.toowordy] 'in the case of' is too wordy
docs/source/development/set_up_pycharm.md|1 col 3| [Kedro.headings] 'Set up PyCharm' should use sentence-style capitalization.
docs/source/development/set_up_pycharm.md|3 col 29| [Kedro.words] Use '' instead of 'quick'.
docs/source/development/set_up_pycharm.md|34 col 1| [Kedro.weaselwords] 'Finally' is a weasel word!
docs/source/development/set_up_pycharm.md|39 col 4| [Kedro.headings] 'Set up Run configurations' should use sentence-style capitalization.
docs/source/development/set_up_pycharm.md|41 col 139| [Kedro.Spellings] Did you really mean 'preconfigured'?
docs/source/development/set_up_pycharm.md|41 col 161| [Kedro.weaselwords] 'rapidly' is a weasel word!
docs/source/development/set_up_pycharm.md|41 col 207| [Kedro.oxfordcomma] Use the Oxford comma in 'This may be useful for testing, running and'.
docs/source/development/set_up_pycharm.md|59 col 58| [Kedro.toowordy] 'Modify' is too wordy
docs/source/development/set_up_pycharm.md|67 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/development/set_up_pycharm.md|75 col 136| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.,'.
docs/source/development/set_up_pycharm.md|75 col 175| [Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/development/set_up_pycharm.md|80 col 11| [Kedro.words] Use '' instead of 'simply'.
docs/source/development/set_up_pycharm.md|80 col 11| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/development/set_up_pycharm.md|84 col 125| [Kedro.Spellings] Did you really mean 'breakpoint'?
docs/source/development/set_up_pycharm.md|91 col 4| [Kedro.headings] 'Advanced: Remote SSH interpreter' should use sentence-style capitalization.
docs/source/development/set_up_pycharm.md|109 col 125| [Kedro.words] Use '' instead of 'just'.
docs/source/development/set_up_pycharm.md|144 col 4| [Kedro.headings] 'Configure Python Console' should use sentence-style capitalization.
docs/source/development/set_up_pycharm.md|156 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'With this configuration, when you create a Python Console you should be able to use context, session and'.
docs/source/development/set_up_pycharm.md|162 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/development/set_up_pycharm.md|162 col 1| [Kedro.oxfordcomma] Use the Oxford comma in 'You can enable the Kedro catalog validation schema in your PyCharm IDE to enable real-time validation, autocompletion and'.
docs/source/development/linting.md|5 col 270| [Kedro.weaselwords] 'likely' is a weasel word!
docs/source/development/linting.md|9 col 207| [Kedro.words] Use '' instead of 'easy'.
docs/source/development/linting.md|17 col 8| [Kedro.Spellings] Did you really mean 'reformats'?
docs/source/development/linting.md|34 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/development/linting.md|34 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/development/linting.md|42 col 178| [Kedro.toowordy] 'equivalent' is too wordy
docs/source/development/linting.md|44 col 68| [Kedro.weaselwords] 'few' is a weasel word!
docs/source/data/advanced_data_catalog_usage.md|3 col 44| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/data/advanced_data_catalog_usage.md|3 col 116| [Kedro.toowordy] 'previously' is too wordy
... (Too many findings. Dropped some findings)
Annotations
Check warning on line 67 in docs/source/kedro_project_setup/session.md
github-actions / vale
[vale] docs/source/kedro_project_setup/session.md#L67
[Kedro.headings] 'ValueError: Package name not found' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'ValueError: Package name not found' should use sentence-style capitalization.", "location": {"path": "docs/source/kedro_project_setup/session.md", "range": {"start": {"line": 67, "column": 6}}}, "severity": "WARNING"}
Check warning on line 68 in docs/source/kedro_project_setup/session.md
github-actions / vale
[vale] docs/source/kedro_project_setup/session.md#L68
[Kedro.Spellings] Did you really mean 'bootstrap_project'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'bootstrap_project'?", "location": {"path": "docs/source/kedro_project_setup/session.md", "range": {"start": {"line": 68, "column": 88}}}, "severity": "WARNING"}