Conversation
Deploying datachain with
|
| Latest commit: |
52719d0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b14bf192.datachain-2g6.pages.dev |
| Branch Preview URL: | https://document-audio-file.datachain-2g6.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds missing documentation to the File class methods and creates comprehensive documentation for AudioFile, similar to existing ImageFile and VideoFile documentation.
Changes:
- Added docstrings to several File class methods (
upload,at,name,parent,ensure_cached) - Removed public documentation from internal methods (
get_file_ext,get_file_stem,get_uri,get_fs_path,get_fs) that are implementation details - Created new AudioFile documentation page following the established pattern for data type documentation
- Fixed incorrect VideoFile link in the references index (was pointing to imagefile.md instead of videofile.md)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/datachain/lib/file.py | Added docstrings with Args/Returns/Examples for upload, at, name, parent, ensure_cached, and rebase methods; removed docstrings from internal methods |
| mkdocs.yml | Added AudioFile to the navigation menu under data types |
| docs/references/index.md | Fixed VideoFile link and added AudioFile to the data types list |
| docs/references/data-types/audiofile.md | New comprehensive documentation page for AudioFile following the pattern of ImageFile and VideoFile docs |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
amritghimire
approved these changes
Feb 16, 2026
ilongin
approved these changes
Feb 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add some missing docs, remove public docs from old, ugly stuff that we should really remove.