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

Document best practices for writing tests for nodes and pipelines #3782

Merged
merged 52 commits into from
Apr 17, 2024

Update tests directory structure

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

Document best practices for writing tests for nodes and pipelines #3782

Update tests directory structure
f967f23
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Apr 17, 2024 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (17)

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!

Filtered Findings (1567)

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/get_started/install.md|11 col 131| [Kedro.Spellings] Did you really mean 'CPython'?
docs/source/get_started/install.md|107 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/get_started/install.md|112 col 17| [Kedro.weaselwords] 'safely' is a weasel word!
docs/source/get_started/install.md|120 col 48| [Kedro.words] Use '' instead of 'simply'.
docs/source/get_started/install.md|120 col 48| [Kedro.weaselwords] 'simply' is a weasel word!
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 90| [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|66 col 37| [Kedro.toowordy] 'demonstrate' is too wordy
docs/source/get_started/new_project.md|123 col 60| [Kedro.words] Use 'after' instead of 'once'.
docs/source/get_started/new_project.md|141 col 14| [Kedro.weaselwords] 'swiftly' is a weasel word!
docs/source/get_started/new_project.md|177 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
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/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
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/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/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/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/configuration/telemetry.md|1 col 3| [Kedro.headings] 'Anonymous Telemetry' should use sentence-style capitalization.
docs/source/configuration/telemetry.md|4 col 19| [Kedro.Spellings] Did you really mean 'anonymised'?
docs/source/configuration/telemetry.md|7 col 27| [Kedro.ukspelling] In general, use UK English spelling instead of 'utilized'.
docs/source/configuration/telemetry.md|21 col 291| [Kedro.toowordy] 'subsequent' is too wordy
docs/source/configuration/telemetry.md|23 col 31| [Kedro.ukspelling] In general, use UK English spelling instead of 'anonymized'.
docs/source/configuration/telemetry.md|23 col 31| [Kedro.Spellings] Did you really mean 'anonymized'?
docs/source/configuration/telemetry.md|34 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/configuration/telemetry.md|46 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/telemetry.md|46 col 292| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/configuration/telemetry.md|56 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/configuration/parameters.md|7 col 54| [Kedro.Spellings] Did you really mean 'hyperparameters'?
docs/source/configuration/parameters.md|7 col 266| [Kedro.toowordy] 'multiple' is too wordy
docs/source/configuration/parameters.md|55 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/configuration/parameters.md|55 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/configuration/parameters.md|69 col 16| [Kedro.words] Use '' instead of 'under the hood'.
docs/source/configuration/credentials.md|4 col 82| [Kedro.Spellings] Did you really mean 'subfolders'?
docs/source/configuration/credentials.md|7 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/config_loader_migration.md|3 col 175| [Kedro.toowordy] 'utilise' is too wordy
docs/source/configuration/config_loader_migration.md|41 col 30| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/config_loader_migration.md|41 col 147| [Kedro.toowordy] 'previously' is too wordy
docs/source/configuration/config_loader_migration.md|41 col 147| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/configuration/config_loader_migration.md|100 col 30| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/config_loader_migration.md|119 col 169| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/config_loader_migration.md|119 col 202| [Kedro.toowordy] 'it was' is too wordy
docs/source/configuration/config_loader_migration.md|156 col 45| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/configuration/config_loader_migration.md|157 col 67| [Kedro.Spellings] Did you really mean 'omegaconf'?
docs/source/configuration/config_loader_migration.md|169 col 88| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/configuration/config_loader_migration.md|212 col 5| [Kedro.headings] '8. Deprecation of Jinja2' should use sentence-style capitalization.
docs/source/configuration/config_loader_migration.md|213 col 70| [Kedro.toowordy] 'However' is too wordy
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/hooks/introduction.md|9 col 112| [Kedro.weaselwords] 'Currently' is a weasel word!
docs/source/hooks/introduction.md|26 col 78| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/hooks/introduction.md|27 col 119| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/hooks/introduction.md|36 col 3| [Kedro.Spellings] Did you really mean 'kedro'?
docs/source/hooks/introduction.md|38 col 5| [Kedro.headings] 'CLI Hooks' should use sentence-style capitalization.
docs/source/hooks/introduction.md|45 col 125| [Kedro.words] Use '' instead of 'under the hood'.
docs/source/hooks/introduction.md|45 col 140| [Kedro.toowordy] 'in order to' is too wordy
docs/source/hooks/introduction.md|45 col 140| [Kedro.words] Use 'to' instead of 'in order to'.
docs/source/hooks/introduction.md|51 col 13| [Kedro.toowordy] 'modify' is too wordy
docs/source/hooks/introduction.md|74 col 1| [Kedro.toowordy] 'However' is too wordy
docs/source/hooks/introduction.md|74 col 17| [Kedro.words] Use '' instead of 'just'.
docs/source/hooks/introduction.md|74 col 139| [Kedro.words] Use '' instead of 'simple'.
docs/source/hooks/introduction.md|122 col 200| [Kedro.words] Use '' instead of 'easily'.
docs/source/hooks/introduction.md|122 col 200| [Kedro.weaselwords] 'easily' is a weasel word!
docs/source/hooks/introduction.md|127 col 48| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/hooks/introduction.md|149 col 25| [Kedro.Spellings] Did you really mean 'pytest's'?
docs/source/hooks/introduction.md|149 col 34| [Kedro.Spellings] Did you really mean 'pluggy'?
docs/source/hooks/introduction.md|149 col 87| [Kedro.toowordy] 'implement' is too wordy
docs/source/hooks/index.md|3 col 78| [Kedro.words] Use '' instead of 'easy'.
docs/source/hooks/index.md|7 col 45| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/hooks/examples.md|13 col 3| [Kedro.toowordy] 'Implement' is too wordy
docs/source/hooks/examples.md|85 col 3| [Kedro.toowordy] 'Implement' is too wordy
docs/source/hooks/examples.md|85 col 61| [Kedro.toowordy] 'validate' is too wordy
docs/source/hooks/examples.md|87 col 5| [Kedro.headings] 'V2 API' should use sentence-style capitalization.
docs/source/hooks/examples.md|152 col 5| [Kedro.headings] 'V3 API' should use sentence-style capitalization.
docs/source/hooks/examples.md|237 col 57| [Kedro.Spellings] Did you really mean 'statsd'?
docs/source/hooks/examples.md|237 col 198| [Kedro.Spellings] Did you really mean 'Grafana'?
docs/source/hooks/examples.md|245 col 3| [Kedro.toowordy] 'Implement' is too wordy
docs/source/hooks/examples.md|295 col 3| [Kedro.toowordy] 'Implement' is too wordy
docs/source/hooks/examples.md|352 col 4| [Kedro.toowordy] 'Modify' is too wordy
docs/source/hooks/examples.md|356 col 193| [Kedro.toowordy] 'implement' is too wordy
docs/source/hooks/examples.md|382 col 63| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/hooks/examples.md|382 col 95| [Kedro.toowordy] 'modify' is too wordy
docs/source/configuration/configuration_basics.md|11 col 4| [Kedro.headings] 'OmegaConfigLoader' should use sentence-style capitalization.
docs/source/configuration/configuration_basics.md|13 col 274| [Kedro.toowordy] 'multiple' is too wordy
docs/source/configuration/configuration_basics.md|29 col 115| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/configuration_basics.md|37 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/configuration_basics.md|39 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/configuration_basics.md|59 col 109| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/configuration/configuration_basics.md|59 col 147| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/configuration/configuration_basics.md|66 col 31| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.,'.
docs/source/configuration/configuration_basics.md|67 col 56| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/configuration/configuration_basics.md|76 col 248| [Kedro.toowordy] 'However' is too wordy
docs/source/configuration/configuration_basics.md|84 col 26| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/configuration/configuration_basics.md|114 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/configuration_basics.md|145 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/configuration_basics.md|147 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/configuration/configuration_basics.md|147 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/configuration/configuration_basics.md|190 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/configuration_basics.md|211 col 1| [Kedro.toowordy] 'In addition' is too wordy
docs/source/configuration/configuration_basics.md|238 col 16| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/configuration_basics.md|239 col 146| [Kedro.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|9 col 335| [Kedro.words] Use '' instead of 'just'.
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|44 col 4| [Kedro.Spellings] Did you really mean 'addtion'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|52 col 3| [Kedro.words] Use '' instead of 'quick'.
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|52 col 181| [Kedro.Spellings] Did you really mean 'Colab'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|250 col 3| [Kedro.Spellings] Did you really mean 'jupyter_ipython_load_node'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|281 col 334| [Kedro.Spellings] Did you really mean 'breakpoint'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|281 col 346| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|281 col 346| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|297 col 3| [Kedro.Spellings] Did you really mean 'pipeline_error_logs'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|308 col 3| [Kedro.Spellings] Did you really mean 'jupyter_ipython_debug_command'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|323 col 4| [Kedro.Spellings] Did you really mean 'jupyter_ipython_pdb_command'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|329 col 78| [Kedro.Spellings] Did you really mean 'ipdb'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|342 col 32| [Kedro.Spellings] Did you really mean 'breakpoint'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|345 col 79| [Kedro.Spellings] Did you really mean 'ipdb'?
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|355 col 5| [Kedro.headings] 'IPython, JupyterLab and other Jupyter clients' should use sentence-style capitalization.
docs/source/configuration/advanced_configuration.md|2 col 82| [Kedro.toowordy] 'satisfy' is too wordy
docs/source/configuration/advanced_configuration.md|23 col 9| [Kedro.toowordy] 'implement' is too wordy
docs/source/configuration/advanced_configuration.md|52 col 105| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/configuration/advanced_configuration.md|77 col 116| [Kedro.oxfordcomma] Use the Oxford comma in 'You can bypass the default configuration (catalog, parameters and'.
docs/source/configuration/advanced_configuration.md|81 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/configuration/advanced_configuration.md|81 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/configuration/advanced_configuration.md|99 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/advanced_configuration.md|115 col 192| [Kedro.weaselwords] 'correctly' is a weasel word!
docs/source/configuration/advanced_configuration.md|118 col 63| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/configuration/advanced_configuration.md|121 col 1| [Kedro.weaselwords] 'Additionally' is a weasel word!
docs/source/configuration/advanced_configuration.md|137 col 184| [Kedro.weaselwords] 'correctly' is a weasel word!
docs/source/configuration/advanced_configuration.md|140 col 132| [Kedro.Spellings] Did you really mean 'mlflow'?
docs/source/configuration/advanced_configuration.md|201 col 30| [Kedro.toowordy] 'indicate' is too wordy
docs/source/configuration/advanced_configuration.md|245 col 86| [Kedro.words] Use '' instead of 'under the hood'.
docs/source/configuration/advanced_configuration.md|270 col 37| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/advanced_configuration.md|270 col 86| [Kedro.toowordy] 'however' is too wordy
docs/source/configuration/advanced_configuration.md|316 col 84| [Kedro.words] Use 'Note:' instead of 'Note that'.
docs/source/configuration/advanced_configuration.md|316 col 122| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/advanced_configuration.md|321 col 25| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/configuration/advanced_configuration.md|322 col 1| [Kedro.toowordy] 'However' is too wordy
docs/source/configuration/advanced_configuration.md|355 col 32| [Kedro.words] Use '' instead of 'please'.
docs/source/configuration/advanced_configuration.md|355 col 39| [Kedro.words] Use 'see', 'read', or 'follow' instead of 'refer to'.
docs/source/configuration/advanced_configuration.md|355 col 49| [Kedro.Spellings] Did you really mean 'configuration_basics'?
docs/source/configuration/advanced_configuration.md|355 col 103| [Kedro.Spellings] Did you really mean 'advanced_configuration'?
docs/source/configuration/advanced_configuration.md|357 col 1| [Kedro.headings] 'How to use Custom Resolvers with *****************' should use sentence-style capitalization.
docs/source/extend_kedro/architecture_overview.md|3 col 29| [Kedro.words] Use 'use' instead of 'leverage'.
docs/source/extend_kedro/architecture_overview.md|5 col 20| [Kedro.toowordy] 'all of' is too wordy
docs/source/extend_kedro/architecture_overview.md|7 col 45| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/extend_kedro/architecture_overview.md|18 col 124| [Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/extend_kedro/architecture_overview.md|21 col 134| [Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/extend_kedro/architecture_overview.md|22 col 68| [Kedro.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
docs/source/extend_kedro/architecture_overview.md|33 col 49| [Kedro.toowordy] 'is responsible for' is too wordy
docs/source/extend_kedro/architecture_overview.md|49 col 124| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/extend_kedro/architecture_overview.md|53 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/extend_kedro/architecture_overview.md|55 col 392| [Kedro.toowordy] 'However' is too wordy
docs/source/extend_kedro/plugins.md|9 col 17| [Kedro.words] Use '' instead of 'simple'.
docs/source/extend_kedro/plugins.md|11 col 11| [Kedro.words] Use '' instead of 'simple'.
docs/source/extend_kedro/plugins.md|32 col 158| [Kedro.words] Use '' instead of 'please'.
docs/source/extend_kedro/plugins.md|32 col 165| [Kedro.words] Use 'see', 'read', or 'follow' instead of 'refer to'.
docs/source/extend_kedro/plugins.md|70 col 45| [Kedro.toowordy] 'prior to' is too wordy
docs/source/extend_kedro/plugins.md|70 col 143| [Kedro.words] Use 'see', 'read', or 'follow' instead of 'refer to'.
docs/source/extend_kedro/plugins.md|70 col 168| [Kedro.weaselwords] 'currently' is a weasel word!
docs/source/extend_kedro/plugins.md|77 col 25| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/extend_kedro/plugins.md|87 col 40| [Kedro.words] Use '' instead of 'simply'.
docs/source/extend_kedro/plugins.md|87 col 40| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/extend_kedro/plugins.md|116 col 4| [Kedro.headings] 'CLI Hooks' should use sentence-style capitalization.
docs/source/extend_kedro/plugins.md|118 col 120| [Kedro.words] Use '' instead of 'please'.
docs/source/extend_kedro/plugins.md|118 col 127| [Kedro.words] Use 'see', 'read', or 'follow' instead of 'visit'.
docs/source/extend_kedro/plugins.md|159 col 106| [Kedro.toowordy] 'all of' is too wordy
docs/source/extend_kedro/plugins.md|168 col 11| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/extend_kedro/plugins.md|181 col 144| [Kedro.Spellings] Did you really mean 'da'?
docs/source/hooks/common_use_cases.md|5 col 167| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/hooks/common_use_cases.md|5 col 216| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/hooks/common_use_cases.md|66 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/hooks/common_use_cases.md|192 col 1| [Kedro.weaselwords] 'Finally' is a weasel word!
docs/source/hooks/common_use_cases.md|219 col 271| [Kedro.Spellings] Did you really mean 'ipdb'?
docs/source/hooks/common_use_cases.md|223 col 93| [Kedro.toowordy] 'implement' is too wordy
docs/source/hooks/common_use_cases.md|258 col 97| [Kedro.toowordy] 'implement' is too wordy
docs/source/extend_kedro/common_use_cases.md|3 col 13| [Kedro.weaselwords] 'few' is a weasel word!
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 3 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L3

[Kedro.toowordy] 'validate' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'validate' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 3, "column": 47}}}, "severity": "WARNING"}

Check warning on line 15 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L15

[Kedro.Spellings] Did you really mean 'parameterising'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'parameterising'?", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 15, "column": 124}}}, "severity": "WARNING"}

Check warning on line 47 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L47

[Kedro.Spellings] Did you really mean 'pytest's'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'pytest's'?", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 47, "column": 195}}}, "severity": "WARNING"}

Check notice on line 53 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L53

[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/tutorial/test_a_project.md", "range": {"start": {"line": 53, "column": 1}}}, "severity": "INFO"}

Check warning on line 53 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L53

[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/tutorial/test_a_project.md", "range": {"start": {"line": 53, "column": 129}}}, "severity": "WARNING"}

Check warning on line 101 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L101

[Kedro.weaselwords] 'equally' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'equally' is a weasel word!", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 101, "column": 215}}}, "severity": "WARNING"}

Check warning on line 103 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L103

[Kedro.toowordy] 'validate' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'validate' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 103, "column": 67}}}, "severity": "WARNING"}

Check warning on line 145 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L145

[Kedro.toowordy] 'However' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'However' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 145, "column": 94}}}, "severity": "WARNING"}

Check warning on line 183 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L183

[Kedro.toowordy] 'evaluate' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'evaluate' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 183, "column": 154}}}, "severity": "WARNING"}

Check warning on line 183 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L183

[Kedro.toowordy] 'validate' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'validate' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 183, "column": 216}}}, "severity": "WARNING"}

Check warning on line 185 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L185

[Kedro.toowordy] 'validate' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'validate' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 185, "column": 158}}}, "severity": "WARNING"}

Check warning on line 185 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L185

[Kedro.Spellings] Did you really mean 'pytest's'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'pytest's'?", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 185, "column": 216}}}, "severity": "WARNING"}

Check warning on line 279 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L279

[Kedro.weaselwords] 'mostly' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'mostly' is a weasel word!", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 279, "column": 103}}}, "severity": "WARNING"}

Check warning on line 321 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L321

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

Check warning on line 321 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L321

[Kedro.weaselwords] 'successfully' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'successfully' is a weasel word!", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 321, "column": 110}}}, "severity": "WARNING"}

Check warning on line 321 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L321

[Kedro.toowordy] 'However' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'However' is too wordy", "location": {"path": "docs/source/tutorial/test_a_project.md", "range": {"start": {"line": 321, "column": 124}}}, "severity": "WARNING"}

Check warning on line 446 in docs/source/tutorial/test_a_project.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/source/tutorial/test_a_project.md#L446

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