Skip to content

[Documentation] Add docs on download_file#2555

Merged
clayandgen merged 2 commits intomainfrom
documentation/download_file
Nov 20, 2025
Merged

[Documentation] Add docs on download_file#2555
clayandgen merged 2 commits intomainfrom
documentation/download_file

Conversation

@clayandgen
Copy link
Copy Markdown
Contributor

closes #2513

The diff looks odd, but I added the docs for download_file and then re-organized the docs a bit to put all the file manipulation related APIs under it's own parent.

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.21%. Comparing base (2951242) to head (189d7b0).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2555      +/-   ##
==========================================
+ Coverage   79.17%   79.21%   +0.03%     
==========================================
  Files         661      662       +1     
  Lines       51214    51218       +4     
  Branches      736      736              
==========================================
+ Hits        40551    40571      +20     
+ Misses      10583    10567      -16     
  Partials       80       80              
Flag Coverage Δ
python 81.29% <ø> (+0.06%) ⬆️
ruby-api 84.56% <ø> (+0.05%) ⬆️
ruby-backend 82.21% <ø> (+0.01%) ⬆️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@clayandgen
Copy link
Copy Markdown
Contributor Author

@jmthomas -- the download_file API lives inside running_script.rb and hence causing the unit test to fail on the bi-directional API documentation check. Let me know how you'd like me to update this accordingly

@clayandgen clayandgen requested review from jmthomas and removed request for ryan-pratt November 19, 2025 17:07
Copy link
Copy Markdown
Member

@jmthomas jmthomas left a comment

Choose a reason for hiding this comment

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

You can whitelist that method since it's coming from a different file. Unless you think we're going to pull in more methods from that file in which case you may want to parse it. But I think whitelisting it is fine.

@clayandgen clayandgen merged commit 6f0776e into main Nov 20, 2025
30 of 31 checks passed
@clayandgen clayandgen deleted the documentation/download_file branch November 20, 2025 15:28
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.

File Download to Local File System

2 participants