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

Clean up and move user guide Python files #1584

Merged
merged 19 commits into from
Apr 15, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Apr 9, 2024

This PR:

  • Removes the majority of comments from the Python files in user guide sections (advanced_composition, basics, customizing_dependencies, data_types_and_io, development_lifecycle, extending, productionizing, testing) since those comments have been turned into Markdown in the Flyte repo.
  • Moves the user guide Python files to a new example_code directory so they don't get consumed by the docs build process.
  • Updates the .flake config file to ignore E402 module level import not at top of file errors because many of the user guide Python files contain multiple examples with multiple imports at different places in the file. I think the reason these errors didn't come up when the files lived in the examples directory was because they were processed by the auto_examples custom extension and not linted as Python files.

After this PR is merged, I will replace the embedded code snippets in the user guide Markdown docs in the Flyte repo with rli (remoteliteralinclude) directives that reference the user guide Python files in this repo. (See flyteorg/flyte#5207).

nikki everett added 12 commits April 9, 2024 10:53
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
nikki everett added 6 commits April 9, 2024 17:02
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett changed the title Clean up user guide example code Clean up and move user guide example code Apr 10, 2024
@neverett neverett changed the title Clean up and move user guide example code Clean up and move user guide Python files Apr 10, 2024
@neverett neverett requested review from pingsutw and brndnblck April 10, 2024 15:43
Signed-off-by: nikki everett <[email protected]>
Copy link
Member

@ppiegaze ppiegaze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@neverett neverett merged commit 93133f9 into master Apr 15, 2024
86 checks passed
@neverett neverett deleted the nikki/user-guide-examples-cleanup branch April 15, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants