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

Make source_dir discoverable for non-src project #3458

Merged
merged 8 commits into from
Jan 8, 2024

Merge branch 'main' into noklam/make-source-dir-discoverable-2962

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

Make source_dir discoverable for non-src project #3458

Merge branch 'main' into noklam/make-source-dir-discoverable-2962
965b538
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Jan 4, 2024 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (1)

docs/source/faq/faq.md|47 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.

Filtered Findings (1549)

[features/steps/test_starter/{{ cookiecutter.repo_name }}/conf/README.md|5 col 149|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_science/README.md#L8) [Kedro.words] Use '' instead of 'simple'.
[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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/pipelines/data_engineering/README.md#L3) [Kedro.toowordy] 'modify' is too wordy
[features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md#L70) [Kedro.headings] 'JupyterLab' should use sentence-style capitalization.
[features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md|83 col 5|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/features/steps/test_starter/{{ cookiecutter.repo_name }}/README.md#L83) [Kedro.headings] 'IPython' should use sentence-style capitalization.
[kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md|5 col 149|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/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/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/conf/README.md#L9) [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
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
CONTRIBUTING.md|3 col 93| [Kedro.weaselwords] 'few' is a weasel word!
CONTRIBUTING.md|9 col 164| [Kedro.weaselwords] 'simply' is a weasel word!
CONTRIBUTING.md|9 col 164| [Kedro.words] Use '' instead of 'simply'.
CONTRIBUTING.md|13 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
CONTRIBUTING.md|13 col 19| [Kedro.weaselwords] 'few' is a weasel word!
CONTRIBUTING.md|17 col 4| [Kedro.headings] 'Join the Technical Steering Committee' should use sentence-style capitalization.
CONTRIBUTING.md|22 col 4| [Kedro.weaselwords] 'regularly' is a weasel word!
CONTRIBUTING.md|26 col 138| [Kedro.Spellings] Did you really mean 'Kedroid'?
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|1 col 3|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L1) [Kedro.headings] '{{ cookiecutter.project_name }}' should use sentence-style capitalization.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|11 col 1|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L11) [Kedro.toowordy] 'In order to' is too wordy
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|57 col 3|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L57) [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|57 col 100|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L57) [Kedro.words] Use 'after' instead of 'once'.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|72 col 5|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L72) [Kedro.headings] 'JupyterLab' should use sentence-style capitalization.
[kedro/templates/project/{{ cookiecutter.repo_name }}/README.md|85 col 5|](https://github.com/kedro-org/kedro/blob/965b538d6d4d331d35dbfa3883f55493a0882e5e/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md#L85) [Kedro.headings] 'IPython' should use sentence-style capitalization.
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/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.weaselwords] 'Alternatively' is a weasel word!
docs/source/configuration/parameters.md|55 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
docs/source/configuration/parameters.md|69 col 16| [Kedro.words] Use '' instead of 'under the hood'.
README.md|13 col 4| [Kedro.weaselwords] 'Monthly' is a weasel word!
README.md|24 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|44 col 53| [Kedro.words] Use '' instead of 'easy'.
README.md|45 col 100| [Kedro.weaselwords] 'many' is a weasel word!
README.md|50 col 11| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|69 col 140| [Kedro.Spellings] Did you really mean 'unvetted'?
README.md|81 col 129| [Kedro.words] Use 'few', 'several', or 'many' instead of 'a number of'.
README.md|81 col 129| [Kedro.toowordy] 'a number of' is too wordy
README.md|83 col 4| [Kedro.headings] 'Can I contribute?' should use sentence-style capitalization.
README.md|83 col 8| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|87 col 14| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|91 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
README.md|93 col 12| [Kedro.pronouns] Avoid first-person singular pronouns such as 'I'.
README.md|98 col 131| [Kedro.Spellings] Did you really mean 'CPython'?
docs/source/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.weaselwords] 'previously' 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|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
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/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 5| [Kedro.headings] 'CLI Hooks' should use sentence-style capitalization.
docs/source/hooks/introduction.md|43 col 125| [Kedro.words] Use '' instead of 'under the hood'.
docs/source/hooks/introduction.md|43 col 140| [Kedro.toowordy] 'in order to' is too wordy
docs/source/hooks/introduction.md|43 col 140| [Kedro.words] Use 'to' instead of 'in order to'.
docs/source/hooks/introduction.md|49 col 13| [Kedro.toowordy] 'modify' is too wordy
docs/source/hooks/introduction.md|72 col 1| [Kedro.toowordy] 'However' is too wordy
docs/source/hooks/introduction.md|72 col 17| [Kedro.words] Use '' instead of 'just'.
docs/source/hooks/introduction.md|72 col 139| [Kedro.words] Use '' instead of 'simple'.
docs/source/hooks/introduction.md|120 col 200| [Kedro.words] Use '' instead of 'easily'.
docs/source/hooks/introduction.md|120 col 200| [Kedro.weaselwords] 'easily' is a weasel word!
docs/source/hooks/introduction.md|125 col 48| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/hooks/introduction.md|147 col 25| [Kedro.Spellings] Did you really mean 'pytest's'?
docs/source/hooks/introduction.md|147 col 34| [Kedro.Spellings] Did you really mean 'pluggy'?
docs/source/hooks/introduction.md|147 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/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.weaselwords] 'Alternatively' is a weasel word!
docs/source/configuration/configuration_basics.md|147 col 1| [Kedro.toowordy] 'Alternatively' is too wordy
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/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/hooks/common_use_cases.md|5 col 163| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/hooks/common_use_cases.md|5 col 212| [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/notebooks_and_ipython/index.md|11 col 274| [Kedro.weaselwords] 'finally' is a weasel word!
docs/source/notebooks_and_ipython/index.md|13 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md|281 col 5| [Kedro.headings] 'Use Kedro's configuration loader to load "magic values"' should use sentence-style capitalization.
docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md|320 col 5| [Kedro.headings] 'Use Kedro's configuration loader to load the Data Catalog' should use sentence-style capitalization.
docs/source/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|349 col 32| [Kedro.words] Use '' instead of 'please'.
docs/source/configuration/advanced_configuration.md|349 col 39| [Kedro.words] Use 'see', 'read', or 'follow' instead of 'refer to'.
docs/source/configuration/advanced_configuration.md|349 col 49| [Kedro.Spellings] Did you really mean 'configuration_basics'?
docs/source/configuration/advanced_configuration.md|349 col 103| [Kedro.Spellings] Did you really mean 'advanced_configuration'?
docs/source/configuration/advanced_configuration.md|351 col 1| [Kedro.headings] 'How to use Custom Resolvers with *****************' should use sentence-style capitalization.
docs/source/starters/create_a_starter.md|38 col 8| [Kedro.weaselwords] 'very' is a weasel word!
docs/source/starters/create_a_starter.md|38 col 8| [Kedro.words] Use '' instead of 'very'.
docs/source/starters/create_a_starter.md|40 col 80| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/starters/create_a_starter.md|40 col 149| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/starters/create_a_starter.md|40 col 196| [Kedro.Spellings] Did you really mean 'cookiecutter'?
docs/source/starters/create_a_starter.md|62 col 44| [Kedro.Spellings] Did you really mean 'subfolder'?
docs/source/starters/create_a_starter.md|119 col 71| [Kedro.toowordy] 'multiple' is too wordy
docs/source/starters/create_a_starter.md|119 col 198| [Kedro.weaselwords] 'only' is a weasel word!
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|247 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/notebooks_and_ipython/kedro_and_notebooks.md|260 col 5| [Kedro.headings] 'IPython, JupyterLab and other Jupyter clients' should use sentence-style capitalization.
docs/source/starters/starters.md|53 col 43| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/starters/index.md|2 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/index.md|2 col 75| [Kedro.words] Use 'after' instead of 'once'.
docs/source/starters/index.md|14 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/index.md|18 col 40| [Kedro.weaselwords] 'additionally' is a weasel word!
docs/source/starters/index.md|33 col 1| [Kedro.weaselwords] 'Additionally' is a weasel word!
docs/source/starters/index.md|36 col 14| [Kedro.toowordy] 'Indicate' is too wordy
docs/source/contribution/technical_steering_committee.md|1 col 3| [Kedro.headings] 'Kedro's Technical Steering Committee' should use sentence-style capitalization.
docs/source/contribution/technical_steering_committee.md|7 col 9| [Kedro.toowordy] 'is responsible for' is too wordy
docs/source/contribution/technical_steering_committee.md|38 col 63| [Kedro.toowordy] 'demonstrate' is too wordy
docs/source/contribution/technical_steering_committee.md|89 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/contribution/technical_steering_committee.md|119 col 166| [Kedro.words] Use 'with' or 'through' instead of 'via'.
docs/source/contribution/technical_steering_committee.md|123 col 2| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/integrations/pyspark_integration.md|1 col 3| [Kedro.headings] 'PySpark integration' should use sentence-style capitalization.
docs/source/integrations/pyspark_integration.md|7 col 29| [Kedro.weaselwords] 'many' is a weasel word!
docs/source/integrations/pyspark_integration.md|7 col 147| [Kedro.toowordy] 'all of' is too wordy
docs/source/integrations/pyspark_integration.md|51 col 12| [Kedro.toowordy] 'modify' is too wordy
docs/source/integrations/pyspark_integration.md|51 col 66| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/integrations/pyspark_integration.md|51 col 79| [Kedro.inclusive] Use 'primary' instead of 'master'.
docs/source/integrations/pyspark_integration.md|53 col 46| [Kedro.toowordy] 'obtain' is too wordy
docs/source/integrations/pyspark_integration.md|55 col 96| [Kedro.toowordy] 'therefore' is too wordy
docs/source/integrations/pyspark_integration.md|65 col 4| [Kedro.headings] 'Use Kedro's built-in Spark datasets to load and save raw data' should use sentence-style capitalization.
docs/source/integrations/pyspark_integration.md|67 col 189| [Kedro.toowordy] 'as to' is too wordy
docs/source/integrations/pyspark_integration.md|109 col 4| [Kedro.headings] 'Spark and Delta Lake interaction' should use sentence-style capitalization.
docs/source/integrations/pyspark_integration.md|111 col 83| [Kedro.Spellings] Did you really mean 'Lakehouse'?
docs/source/integrations/pyspark_integration.md|116 col 99| [Kedro.toowordy] 'type of' is too wordy
docs/source/integrations/pyspark_integration.md|146 col 119| [Kedro.abbreviations] Use 'that is' instead of abbreviations like 'i.e.'.
docs/source/integrations/pyspark_integration.md|173 col 293| [Kedro.words] Use '' instead of 'simply'.
docs/source/integrations/pyspark_integration.md|173 col 293| [Kedro.weaselwords] 'simply' is a weasel word!
docs/source/integrations/pyspark_integration.md|198 col 197| [Kedro.Spellings] Did you really mean 'ML's'?
docs/source/integrations/pyspark_integration.md|245 col 64| [Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.
docs/source/integrations/pyspark_integration.md|245 col 263| [Kedro.toowordy] 'In order to' is too wordy
docs/source/integrations/pyspark_integration.md|251 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/integrations/pyspark_integration.md|251 col 105| [Kedro.weaselwords] 'roughly' is a weasel word!
docs/source/integrations/pyspark_integration.md|251 col 177| [Kedro.toowordy] 'therefore' is too wordy
docs/source/integrations/pyspark_integration.md|251 col 201| [Kedro.weaselwords] 'roughly' is a weasel word!
docs/source/integrations/pyspark_integration.md|251 col 398| [Kedro.toowordy] 'In order to' is too wordy
docs/source/starters/new_project_tools.md|113 col 37| [Kedro.toowordy] 'demonstrate' is too wordy
docs/source/starters/new_project_tools.md|229 col 497| [Kedro.weaselwords] 'only' is a weasel word!
docs/source/starters/new_project_tools.md|231 col 138| [Kedro.Spellings] Did you really mean 'naviagting'?
docs/source/starters/new_project_tools.md|244 col 52| [Kedro.toowordy] 'implement' is too wordy
docs/source/starters/new_project_tools.md|248 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/new_project_tools.md|250 col 141| [Kedro.Spellings] Did you really mean 'URIs'?
docs/source/starters/new_project_tools.md|254 col 5| [Kedro.headings] 'PySpark' should use sentence-style capitalization.
docs/source/starters/new_project_tools.md|256 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/new_project_tools.md|260 col 5| [Kedro.headings] 'Kedro Viz' should use sentence-style capitalization.
docs/source/starters/new_project_tools.md|262 col 1| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/starters/new_project_tools.md|263 col 1| [Kedro.toowordy] 'In addition' is too wordy
docs/source/starters/new_project_tools.md|274 col 3| [Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
docs/source/nodes_and_pipelines/pipeline_introduction.md|3 col 4| [Kedro.toowordy] 'previously' is too wordy
docs/source/nodes_and_pipelines/pipeline_introduction.md|3 col 4| [Kedro.weaselwords] 'previously' is a weasel word!
docs/source/nodes_and_pipelines/pipeline_introduction.md|5 col 4| [Kedro.toowordy] 'benefit from' is too wordy

Annotations

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

See this annotation in the file changed.

@github-actions github-actions / vale

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

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