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] Align fd code lines with Flytesnacks examples #6149

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JiangJiaWei1103
Copy link
Contributor

@JiangJiaWei1103 JiangJiaWei1103 commented Jan 8, 2025

Tracking issue

NA

Why are the changes needed?

Due to the transition from rli to literalinclude, two code snippets on FlyteDirectory page are out of sync of the following two Flytesnacks examples, folder.py and file_streaming.py.

What changes were proposed in this pull request?

Align code snippets on the doc page with two corresponding examples.

Check all the applicable boxes

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

Related PRs

#6008

Docs link

https://flyte--6149.org.readthedocs.build/en/6149/user_guide/data_types_and_io/flytedirectory.html

Signed-off-by: JiaWei Jiang <waynechuang97@gmail.com>
@flyte-bot
Copy link
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at eduardo@union.ai.

Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.02%. Comparing base (27c9edd) to head (1520498).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6149   +/-   ##
=======================================
  Coverage   37.01%   37.02%           
=======================================
  Files        1317     1317           
  Lines      132523   132523           
=======================================
+ Hits        49060    49066    +6     
+ Misses      79217    79211    -6     
  Partials     4246     4246           
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.25% <ø> (+0.02%) ⬆️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.85% <ø> (ø)
unittests-flytepropeller 42.64% <ø> (ø)
unittests-flytestdlib 55.18% <ø> (ø)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants