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

Second draft of file bundle adapter docs. #1709

Merged

Conversation

ssteinbach
Copy link
Collaborator

Following conversation with @darbyjohnston, an attempt to clean up and clarify the documentation for the file bundle adpaters.

@ssteinbach ssteinbach added this to the Public Beta 16 milestone Mar 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 6, 2024

Codecov Report

Attention: Patch coverage is 90.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 81.71%. Comparing base (c0e97b0) to head (6380c80).
Report is 18 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1709      +/-   ##
==========================================
- Coverage   84.11%   81.71%   -2.41%     
==========================================
  Files         198      176      -22     
  Lines       22241    12316    -9925     
  Branches     4687     3018    -1669     
==========================================
- Hits        18709    10064    -8645     
+ Misses       2610     1711     -899     
+ Partials      922      541     -381     
Flag Coverage Δ
py-unittests 81.71% <90.00%> (-2.41%) ⬇️

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

Files Coverage Δ
...ineio/opentimelineio/adapters/file_bundle_utils.py 71.87% <100.00%> (-0.44%) ⬇️
...py-opentimelineio/opentimelineio/adapters/otiod.py 80.95% <100.00%> (-0.45%) ⬇️
...py-opentimelineio/opentimelineio/adapters/otioz.py 84.61% <100.00%> (-0.39%) ⬇️
src/py-opentimelineio/opentimelineio/url_utils.py 85.18% <86.66%> (ø)

... and 62 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5dff8be...6380c80. Read the comment docs.

@ssteinbach ssteinbach marked this pull request as draft April 11, 2024 17:08
@ssteinbach ssteinbach force-pushed the main.filebundledocclarify branch 2 times, most recently from 9ce9ac3 to c47eeb9 Compare April 12, 2024 05:12
@ssteinbach ssteinbach marked this pull request as ready for review July 16, 2024 05:25
@ssteinbach ssteinbach marked this pull request as draft July 16, 2024 05:28
@ssteinbach ssteinbach marked this pull request as ready for review July 16, 2024 05:36
@darbyjohnston
Copy link
Contributor

Thanks for updating the text, looks good to me.

I'm not super familiar with Python, but it looks like there aren't any functional changes, just documentation and refactoring?

@ssteinbach
Copy link
Collaborator Author

@darbyjohnston correct

@ssteinbach ssteinbach merged commit 42158eb into AcademySoftwareFoundation:main Jul 17, 2024
56 checks passed
@ssteinbach ssteinbach deleted the main.filebundledocclarify branch July 17, 2024 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants