AcademySoftwareFoundation / AcademySoftwareFoundation/OpenTimelineIO

Bring documentation from python OpenTime library forward to the C++ methods and the docstrings

Open
#704 2 comments 0 reactions 0 assignees View on GitHub
good first issue roadmap
Dominant language
C++
Stars
2k
Forks
351
Avg merge
1d 12h
Merged PRs (30d)
1

Description

The original python implementation of OpenTimelineIO had docstrings on many of the functions and methods in opentime. We should bring these forward into the C++ and also the python bindings so that users have that information readily available.

documentation:
https://github.com/PixarAnimationStudios/OpenTimelineIO/blob/last_pure_python/opentimelineio/opentime.py

Contributor guide

Open the contributing guide

Research direction

Start with the original documentation in opentimelineio/opentime.py from the linked last_pure_python revision, then locate the corresponding C++ methods and Python bindings. The work is done when the relevant documentation is available in both the C++ APIs and their Python bindings.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.