Task library documentation and structure clean up #3360
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcrist
reviewed
Sep 21, 2020
Co-authored-by: Jim Crist-Harif <jcrist@users.noreply.github.com>
Co-authored-by: Jim Crist-Harif <jcrist@users.noreply.github.com>
jcrist
previously approved these changes
Sep 22, 2020
.flake8
Outdated
| @@ -11,7 +11,7 @@ ignore = | |||
| E203, | |||
| # Comparing types instead of isinstance | |||
| E721, | |||
| # Assign a lambda | |||
| # Assign a lam\bda | |||
jcrist
previously approved these changes
Sep 22, 2020
cicdw
reviewed
Sep 22, 2020
There was a problem hiding this comment.
Left some comments - we can merge this as-is and revisit the comments for the full post + as follow-up PRs. In general I think we might want to expand on "design" for tasks (e.g., what to include in init vs run) and maybe provide some examples but this is still a great start
|
Was just in a conversation with @kingsleyb and I realized we need to document things like our desired pattern for interacting with secrets and also some more information WRT init and run kwargs, stand by |
Co-authored-by: Chris White <chris@prefect.io>
3 tasks
cicdw
approved these changes
Sep 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR cleans up the task library documentation and moves around some files that were previously in
/contrib.Changes
/contribprefect.contrib.taskstoprefect.tasks(warning raise if imported from old location)Importance
Task library was missing a true home for documentation. The
contribdirectory is not useful and it doesn't benefit having some tasks separate from the rest.Checklist
This PR:
changes/directory (if appropriate)docs/outline.tomlfor API reference docs (if appropriate)