Improve docstring for GcsOptions tribools.

RobotLocomotion / drake

Model-based design and verification for robotics.

https://drake.mit.edu

Other

3.16k stars 1.24k forks source link

Improve docstring for GcsOptions tribools. #21602

Closed RussTedrake closed 5 days ago

RussTedrake commented 1 week ago

A few people have been confused about this. Currently and most notably, GcsTrajOpt chooses different default values than GCS, but I've stopped short of saying that in the docstring, because I would not want that detail registered in two different places where it could get stale.

+@AlexandreAmice for feature review, please.

This change is

RussTedrake commented 1 week ago

+@seancurtis-tri for platform review, please.

SeanCurtis-TRI commented 5 days ago

+(status: squashing now)