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

Fix inconsistent code examples in caching.md documentation #6077

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

davidlin20dev
Copy link
Contributor

Why are the changes needed?

The code block examples in the Caching documentation look misaligned. This might be due to new code being added to the original file in flytesnacks, which would shift the line numbers. I'm adjusting the line references to match the current code.

What changes were proposed in this pull request?

Please refer to the changed file down below.

Check all the applicable boxes

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

Screenshots

Screenshot 2024-12-03 at 17 09 58
Screenshot 2024-12-03 at 17 10 09
Screenshot 2024-12-03 at 17 10 21

Docs link

First code block
Second code block
Third code block

The code block examples in the Caching documentation look misaligned. This might be due to new code being added to the original file in flytesnacks, which would shift the line numbers. I'm adjusting the line references to match the current code.

Signed-off-by: David (Ti-Wei) Lin <[email protected]>
Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.09%. Comparing base (ba331fd) to head (c4b00cf).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6077      +/-   ##
==========================================
- Coverage   37.10%   37.09%   -0.01%     
==========================================
  Files        1318     1318              
  Lines      132331   132331              
==========================================
- Hits        49097    49094       -3     
- Misses      78961    78965       +4     
+ Partials     4273     4272       -1     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.07% <ø> (-0.03%) ⬇️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.82% <ø> (ø)
unittests-flytepropeller 42.63% <ø> (ø)
unittests-flytestdlib 57.59% <ø> (+0.05%) ⬆️

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.

@ppiegaze ppiegaze merged commit 1332408 into flyteorg:master Dec 5, 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
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants