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

Add C++ docs to repository #610

Merged
merged 6 commits into from Nov 7, 2019

Conversation

@ssteinbach
Copy link
Member

ssteinbach commented Nov 2, 2019

Adds documentation by @davidbaraff on the design and implementation of the C++ core and pybind11 wrapper.

Co-authored by: @davidbaraff

@ssteinbach ssteinbach added this to the Public Beta 12 milestone Nov 2, 2019
@ssteinbach ssteinbach requested a review from davidbaraff Nov 2, 2019
@ssteinbach ssteinbach added this to To Do in C++ API via automation Nov 2, 2019
@codecov-io

This comment has been minimized.

Copy link

codecov-io commented Nov 2, 2019

Codecov Report

Merging #610 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #610   +/-   ##
=======================================
  Coverage   81.69%   81.69%           
=======================================
  Files          72       72           
  Lines        2732     2732           
=======================================
  Hits         2232     2232           
  Misses        500      500
Flag Coverage Δ
#py27 81.67% <ø> (ø) ⬆️
#py36 81.67% <ø> (ø) ⬆️
#py37 81.67% <ø> (ø) ⬆️

Continue to review full report at Codecov.

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

Copy link
Collaborator

reinecke left a comment

This is super helpful! While the C++ is already pretty approachable, this adds a ton of clarity.

void set_marked_range(TimeRange marked_range);

std::string const& color() const;
void set_color(std::string const& colir);

This comment has been minimized.

Copy link
@reinecke

reinecke Nov 4, 2019

Collaborator

should colir be color?

docs/cxx/cxx.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

davidbaraff left a comment

Looks good. There are some minor typos in the documents that could be corrected, but it's not that important and it can be done later.

@ssteinbach ssteinbach merged commit 8392360 into PixarAnimationStudios:master Nov 7, 2019
1 check passed
1 check passed
Travis CI - Pull Request Build Passed
Details
C++ API automation moved this from To Do to Done Nov 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
C++ API
  
Done
4 participants
You can’t perform that action at this time.