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

docs: Refactor merge sort code example to use literalinclude #6091

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

davidlin20dev
Copy link
Contributor

@davidlin20dev davidlin20dev commented Dec 6, 2024

Why are the changes needed?

Since I recently added the merge sort code to advanced_composition/dynamic_workflow.py, it makes sense to just reference it using literalinclude instead of copying the code into the docs.

What changes were proposed in this pull request?

Please refer to the Files changed.

Before: Raw Python code included directly in docs
After: Using literalinclude to reference code from flytesnacks

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

flyteorg/flytesnacks#1771

Docs link

https://docs.flyte.org/en/latest/user_guide/advanced_composition/dynamic_workflows.html#merge-sort

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.09%. Comparing base (9dc21f4) to head (9168ce3).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6091      +/-   ##
==========================================
- Coverage   37.10%   37.09%   -0.01%     
==========================================
  Files        1318     1318              
  Lines      132403   132403              
==========================================
- Hits        49122    49121       -1     
- Misses      79009    79010       +1     
  Partials     4272     4272              
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.10% <ø> (ø)
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.82% <ø> (ø)
unittests-flytepropeller 42.60% <ø> (ø)
unittests-flytestdlib 57.57% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@pingsutw pingsutw left a comment

Choose a reason for hiding this comment

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

thank you!

@pingsutw pingsutw merged commit 9028375 into flyteorg:master Dec 6, 2024
52 checks passed
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