Context

Currently, most of the detailed information about what options do is only on the *Options structs. However, in v2, we expect most people to only use the options setter methods, which mostly just reference the *Options struct fields for full documentation. We should move or copy all documentation from the *Options struct fields to the setter methods.

Definition of done

• Move all option documentation from the *Options struct field to the corresponding setter method.
• (Optional) Consider keeping either a full copy of the entire documentation on the struct field, or adding a reference to the relevant setter for each *Options struct field, which allows users to make sense of the struct fields if necessary.
  • The downside to keeping an entire copy in both places is that it's hard to maintain, introducing the opportunity for stale and out-of-sync documentation that confuses users.

Pitfalls