Add documentation for versioning with DVC in Kedro #5038
reviewdog [vale] report
reported by reviewdog 🐶
Findings (14)
docs/source/data/kedro_dvc_versioning.md|3 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/data/kedro_dvc_versioning.md|7 col 5| [Kedro.ukspelling] In general, use UK English spelling instead of 'Initializing'.
docs/source/data/kedro_dvc_versioning.md|9 col 98| [Kedro.Spellings] Did you really mean 'preconfigured'?
docs/source/data/kedro_dvc_versioning.md|46 col 161| [Kedro.toowordy] 'for the purpose of' is too wordy
docs/source/data/kedro_dvc_versioning.md|50 col 33| [Kedro.Spellings] Did you really mean 'commited'?
docs/source/data/kedro_dvc_versioning.md|63 col 146| [Kedro.weaselwords] 'Usually' is a weasel word!
docs/source/data/kedro_dvc_versioning.md|83 col 4| [Kedro.headings] 'Versioning with DVC Data Pipelines' should use sentence-style capitalization.
docs/source/data/kedro_dvc_versioning.md|93 col 5| [Kedro.headings] 'Defining Kedro Pipelines as DVC Stages' should use sentence-style capitalization.
docs/source/data/kedro_dvc_versioning.md|124 col 5| [Kedro.headings] 'Updating a Dataset' should use sentence-style capitalization.
docs/source/data/kedro_dvc_versioning.md|126 col 50| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/data/kedro_dvc_versioning.md|130 col 5| [Kedro.headings] 'Tracking Code Changes' should use sentence-style capitalization.
docs/source/data/kedro_dvc_versioning.md|157 col 5| [Kedro.headings] 'Tracking Parameters' should use sentence-style capitalization.
docs/source/data/kedro_dvc_versioning.md|159 col 53| [Kedro.Spellings] Did you really mean 'params'?
docs/source/data/kedro_dvc_versioning.md|183 col 5| [Kedro.headings] 'Running Experiments with Different Parameters' should use sentence-style capitalization.
Filtered Findings (1751)
kedro_benchmarks/README.md|18 col 205| [Kedro.weaselwords] 'only' is a weasel word!
[features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md|5 col 149|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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_science/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md#L8) [Kedro.words] Use '' instead of 'simple'.
SECURITY.md|3 col 44| [Kedro.weaselwords] 'seriously' is a weasel word!
[kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md|5 col 149|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/kedro/templates/project/{{ 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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_engineering/README.md#L3) [Kedro.toowordy] 'modify' is too wordy
.github/ISSUE_TEMPLATE/software_design_proposal.md|32 col 4| [Kedro.Spellings] Did you really mean 'Rollout'?
[features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md#L70) [Kedro.headings] 'JupyterLab' should use sentence-style capitalization.
.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/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/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.
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
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/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|13 col 1|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L13) [Kedro.toowordy] 'In order to' is too wordy
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|59 col 3|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L59) [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|59 col 100|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L59) [Kedro.words] Use 'after' instead of 'once'.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|74 col 5|](https://github.com/kedro-org/kedro/blob/3b2fca8d8c92a4009b4a46d6b9fa02fa5ed0061d/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L74) [Kedro.headings] 'JupyterLab' should use sentence-style capitalization.
docs/source/tutorial/tutorial_template.md|77 col 49| [Kedro.weaselwords] 'easily' is a weasel word!
docs/source/tutorial/tutorial_template.md|77 col 49| [Kedro.words] Use '' instead of 'easily'.
docs/source/tutorial/tutorial_template.md|78 col 45| [Kedro.weaselwords] 'only' is a weasel word!
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.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/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 dataset' should use sentence-style capitalization.
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/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|162 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/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/course/index.md|5 col 239| [Kedro.oxfordcomma] Use the Oxford comma in 'Along the way, you'll learn key Kedro concepts like datasets and the Kedro Data Catalog, nodes and'.
docs/source/course/index.md|14 col 153| [Kedro.weaselwords] 'likely' is a weasel word!
docs/source/course/index.md|14 col 214| [Kedro.weaselwords] 'regularly' is a weasel word!
docs/source/course/index.md|23 col 103| [Kedro.Spellings] Did you really mean 'reusability'?
docs/source/course/index.md|44 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/course/index.md|50 col 5| [Kedro.headings] 'Part 0: Introduction' should use sentence-style capitalization.
docs/source/course/index.md|72 col 21| [Kedro.Spellings] Did you really mean 'dataframes'?
docs/source/course/index.md|89 col 5| [Kedro.headings] 'Part 4: Where next?' should use sentence-style capitalization.
docs/source/logging/index.md|6 col 20| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/logging/index.md|9 col 270| [Kedro.Spellings] Did you really mean 'traceback'?
docs/source/logging/index.md|12 col 34| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/logging/index.md|39 col 45| [Kedro.toowordy] 'subsequent' is too wordy
docs/source/logging/index.md|47 col 123| [Kedro.Spellings] Did you really mean 'jupyter'?
docs/source/logging/index.md|62 col 269| [Kedro.toowordy] 'However' is too wordy
docs/source/logging/index.md|69 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/logging/index.md|139 col 64| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/logging/index.md|143 col 1| [Kedro.toowordy] 'In addition' is too wordy
docs/source/logging/index.md|152 col 293| [Kedro.toowordy] 'However' is too wordy
docs/source/logging/index.md|158 col 277| [Kedro.Spellings] Did you really mean 'traceback's'?
docs/source/logging/index.md|173 col 141| [Kedro.words] Use '' instead of 'easy'.
docs/source/logging/index.md|173 col 157| [Kedro.toowordy] 'However' is too wordy
docs/source/logging/index.md|173 col 198| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/logging/index.md|173 col 231| [Kedro.Spellings] Did you really mean 'Repos'?
docs/source/logging/index.md|183 col 15| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/logging/index.md|197 col 255| [Kedro.words] Use '' instead of 'just'.
docs/source/logging/index.md|197 col 280| [Kedro.weaselwords] 'likely' is a weasel word!
docs/source/logging/index.md|197 col 331| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/logging/index.md|199 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/logging/index.md|215 col 106| [Kedro.toowordy] 'However' is too wordy
docs/source/logging/index.md|223 col 14| [Kedro.Spellings] Did you really mean 'cookiecutter'?
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/faq/faq.md|1 col 3| [Kedro.headings] 'FAQs' should use sentence-style capitalization.
docs/source/faq/faq.md|9 col 13| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|11 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|12 col 123| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|18 col 4| [Kedro.headings] 'Working with Notebooks' should use sentence-style capitalization.
docs/source/faq/faq.md|20 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|21 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|22 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|27 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|27 col 19| [Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
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|32 col 55| [Kedro.words] Use 'runtime' instead of 'run time'.
docs/source/faq/faq.md|33 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|33 col 35| [Kedro.words] Use 'runtime' instead of 'run time'.
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|38 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|39 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|40 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|40 col 17| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/faq/faq.md|41 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|47 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|51 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|52 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|53 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|58 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|59 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|59 col 20| [Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
docs/source/faq/faq.md|60 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
docs/source/faq/faq.md|64 col 8| [Kedro.Spellings] Did you really mean 'Philp'?
docs/source/faq/faq.md|71 col 3| [Kedro.Spellings] Did you really mean 'data_engineering_convention'?
docs/source/faq/faq.md|75 col 224| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/faq/faq.md|76 col 99| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/faq/faq.md|79 col 114| [Kedro.toowordy] 'in the case of' is too wordy
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
docs/source/data/advanced_data_catalog_usage.md|3 col 116| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/data/advanced_data_catalog_usage.md|41 col 374| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/data/advanced_data_catalog_usage.md|75 col 27| [Kedro.toowordy] 'similar to' is too wordy
docs/source/data/advanced_data_catalog_usage.md|145 col 4| [Kedro.headings] 'How to version a dataset using the Code API' should use sentence-style capitalization.
docs/source/data/advanced_data_catalog_usage.md|205 col 11| [Kedro.words] Use '' instead of 'simple'.
docs/source/data/how_to_create_a_custom_dataset.md|3 col 147| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/data/how_to_create_a_custom_dataset.md|5 col 4| [Kedro.headings] 'AbstractDataset' should use sentence-style capitalization.
docs/source/data/how_to_create_a_custom_dataset.md|7 col 255| [Kedro.toowordy] 'implement' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|12 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/data/how_to_create_a_custom_dataset.md|12 col 178| [Kedro.toowordy] 'type of' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|12 col 249| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/data/how_to_create_a_custom_dataset.md|12 col 272| [Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/data/how_to_create_a_custom_dataset.md|18 col 178| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/data/how_to_create_a_custom_dataset.md|18 col 276| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/data/how_to_create_a_custom_dataset.md|20 col 189| [Kedro.words] Use '' instead of 'just'.
docs/source/data/how_to_create_a_custom_dataset.md|39 col 25| [Kedro.toowordy] 'however' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|41 col 18| [Kedro.Spellings] Did you really mean 'boolean'?
docs/source/data/how_to_create_a_custom_dataset.md|41 col 108| [Kedro.toowordy] 'in the case of' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|95 col 10| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/data/how_to_create_a_custom_dataset.md|103 col 4| [Kedro.toowordy] 'Implement' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|105 col 1| [Kedro.weaselwords] 'Many' is a weasel word!
docs/source/data/how_to_create_a_custom_dataset.md|105 col 284| [Kedro.weaselwords] 'particularly' is a weasel word!
docs/source/data/how_to_create_a_custom_dataset.md|153 col 67| [Kedro.Spellings] Did you really mean 'Pikachu's'?
docs/source/data/how_to_create_a_custom_dataset.md|175 col 4| [Kedro.toowordy] 'Implement' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|177 col 19| [Kedro.toowordy] 'implement' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|198 col 64| [Kedro.weaselwords] 'correctly' is a weasel word!
docs/source/data/how_to_create_a_custom_dataset.md|200 col 4| [Kedro.toowordy] 'Implement' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|276 col 1| [Kedro.weaselwords] 'Currently' is a weasel word!
docs/source/data/how_to_create_a_custom_dataset.md|276 col 31| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/data/how_to_create_a_custom_dataset.md|278 col 126| [Kedro.toowordy] 'multiple' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|309 col 12| [Kedro.toowordy] 'implement' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|321 col 127| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/data/how_to_create_a_custom_dataset.md|486 col 77| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/data/how_to_create_a_custom_dataset.md|516 col 152| [Kedro.Spellings] Did you really mean 'serialisable'?
docs/source/data/how_to_create_a_custom_dataset.md|516 col 360| [Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
docs/source/data/how_to_create_a_custom_dataset.md|518 col 231| [Kedro.toowordy] 'therefore' is too wordy
docs/source/data/how_to_create_a_custom_dataset.md|520 col 35| [Kedro.Spellings] Did you really mean 'serialisable'?
docs/source/data/partitioned_and_incremental_datasets.md|10 col 169| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/data/partitioned_and_incremental_datasets.md|53 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/data/partitioned_and_incremental_datasets.md|53 col 1| [Kedro.weaselwords] 'Alternatively' is a weasel word!
docs/source/data/partitioned_and_incremental_datasets.md|79 col 189| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.,'.
docs/source/data/partitioned_and_incremental_datasets.md|83 col 147| [Kedro.Spellings] Did you really mean 'initialiser'?
docs/source/data/partitioned_and_incremental_datasets.md|92 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/data/partitioned_and_incremental_datasets.md|92 col 14| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/data/partitioned_and_incremental_datasets.md|92 col 84| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/data/partitioned_and_incremental_datasets.md|107 col 215| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/data/partitioned_and_incremental_datasets.md|155 col 324| [Kedro.toowordy] 'implement' is too wordy
docs/source/data/partitioned_and_incremental_datasets.md|157 col 65| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/data/partitioned_and_incremental_datasets.md|164 col 22| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
... (Too many findings. Dropped some findings)
Annotations
Check notice on line 3 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L3
[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/data/kedro_dvc_versioning.md", "range": {"start": {"line": 3, "column": 1}}}, "severity": "INFO"}
Check warning on line 7 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L7
[Kedro.ukspelling] In general, use UK English spelling instead of 'Initializing'.
Raw output
{"message": "[Kedro.ukspelling] In general, use UK English spelling instead of 'Initializing'.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 7, "column": 5}}}, "severity": "WARNING"}
Check warning on line 9 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L9
[Kedro.Spellings] Did you really mean 'preconfigured'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'preconfigured'?", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 9, "column": 98}}}, "severity": "WARNING"}
Check warning on line 46 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L46
[Kedro.toowordy] 'for the purpose of' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'for the purpose of' is too wordy", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 46, "column": 161}}}, "severity": "WARNING"}
Check warning on line 50 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L50
[Kedro.Spellings] Did you really mean 'commited'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'commited'?", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 50, "column": 33}}}, "severity": "WARNING"}
Check warning on line 63 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L63
[Kedro.weaselwords] 'Usually' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'Usually' is a weasel word!", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 63, "column": 146}}}, "severity": "WARNING"}
Check warning on line 83 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L83
[Kedro.headings] 'Versioning with DVC Data Pipelines' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Versioning with DVC Data Pipelines' should use sentence-style capitalization.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 83, "column": 4}}}, "severity": "WARNING"}
Check warning on line 93 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L93
[Kedro.headings] 'Defining Kedro Pipelines as DVC Stages' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Defining Kedro Pipelines as DVC Stages' should use sentence-style capitalization.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 93, "column": 5}}}, "severity": "WARNING"}
Check warning on line 124 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L124
[Kedro.headings] 'Updating a Dataset' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Updating a Dataset' should use sentence-style capitalization.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 124, "column": 5}}}, "severity": "WARNING"}
Check warning on line 126 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L126
[Kedro.weaselwords] 'only' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'only' is a weasel word!", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 126, "column": 50}}}, "severity": "WARNING"}
Check warning on line 130 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L130
[Kedro.headings] 'Tracking Code Changes' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Tracking Code Changes' should use sentence-style capitalization.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 130, "column": 5}}}, "severity": "WARNING"}
Check warning on line 157 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L157
[Kedro.headings] 'Tracking Parameters' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Tracking Parameters' should use sentence-style capitalization.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 157, "column": 5}}}, "severity": "WARNING"}
Check warning on line 159 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L159
[Kedro.Spellings] Did you really mean 'params'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'params'?", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 159, "column": 53}}}, "severity": "WARNING"}
Check warning on line 183 in docs/source/data/kedro_dvc_versioning.md
github-actions / vale
[vale] docs/source/data/kedro_dvc_versioning.md#L183
[Kedro.headings] 'Running Experiments with Different Parameters' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Running Experiments with Different Parameters' should use sentence-style capitalization.", "location": {"path": "docs/source/data/kedro_dvc_versioning.md", "range": {"start": {"line": 183, "column": 5}}}, "severity": "WARNING"}