Add deprecation warnings in the docs for commands being removed in 0.19.0 #1912
Conversation
|
We're not removing those commands until |
Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
jmholzer
force-pushed
the
docs/remove-references-to-kedro-test
branch
from
46ce700 to
ecd8210
Compare
Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
jmholzer
changed the title
kedro test and kedro lint in docs
| * [`kedro activate-nbstripout`](#strip-output-cells) | ||
| * [`kedro build-docs`](#build-the-project-documentation) | ||
| * [`kedro build-reqs`](#build-the-projects-dependency-tree) | ||
| * [`kedro activate-nbstripout (deprecated from version 0.19.0)`](#strip-output-cells) |
There was a problem hiding this comment.
| * [`kedro activate-nbstripout (deprecated from version 0.19.0)`](#strip-output-cells) | |
| * [`kedro activate-nbstripout`](#strip-output-cells)(deprecated from version 0.19.0) |
There was a problem hiding this comment.
I'd change the formatting so that "(deprecated from version 0.19.0)" is not part of the link. Also for all the ones below.
There was a problem hiding this comment.
Fixed in the latest commits.
There was a problem hiding this comment.
I didn't mean to remove the "(deprecated from version 0.19.0)" completely, just to have it outside of the linked text so it would be: kedro activate-nbstripout(deprecated from version 0.19.0) etc.
There was a problem hiding this comment.
Sure, I fixed this in the latest commit.
| ___ | ||
| _This command will be deprecated from Kedro version 0.19.0._ | ||
| ___ |
There was a problem hiding this comment.
We don't really use this style of formatting anywhere else. Perhaps just add this as a {note} or with > indenting.
See https://github.com/kedro-org/kedro/blob/main/docs/source/tutorial/create_pipelines.md for example of "notes"
There was a problem hiding this comment.
I understand, I fixed it to use note syntax in the latest commits.
| @@ -390,6 +402,10 @@ The following runs all `pytest` unit tests found in `src/tests`, including cover | |||
| kedro test | |||
| ``` | |||
|
|
|||
| ___ | |||
There was a problem hiding this comment.
For the kedro test and kedro lint commands we can link to the new doc pages.
There was a problem hiding this comment.
I agree this is a good idea, though I would prefer to wait until #1904 is merged, so that the path to the new docs page is concrete.
Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
…ro-org/kedro into docs/remove-references-to-kedro-test Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
|
Thanks for the reviews @noklam and @MerelTheisenQB! I made the suggested changes. |
jmholzer
changed the title
Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
…19.0 (kedro-org#1912) * Add deprecation warnings to commands_reference.md Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Move deprecation notes to fix 'phase transition' at beginning of section Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Change positioning of deprecation messages to be under bash line Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Change deprecation message formatting Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Fix note syntax Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> * Add deprecation note to list of contents Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com> Co-authored-by: Nok Lam Chan <mediumnok@gmail.com> Signed-off-by: nickolasrm <nickolasrochamachado@gmail.com>
Signed-off-by: Jannic Holzer jannic.holzer@quantumblack.com
Description
In Kedro version 0.19.0, six commands are being deprecated (#1617). This PR adds deprecation notices for these commands to the documentation.
Development notes
I manually checked that the docs still build successfully.
Checklist
RELEASE.mdfile