You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Document which objects are "expensive" to create. #802
"Expensive" is a relative term, but we should setup some basic metrics: some constructors just allocate a few objects, others open connections to remote servers. We should give some guidance to users about the relative costs of these operations, for example, TableAdmin could say:
/** * Normal documentation stuff here. * * @par Cost * Creating a new object of type TableAdmin is comparable to creating a few objects of type * std::string or a few objects of type std::shared_ptr<int>. The class represents a shallow handle * to a remote object.*/classTableAdmin ...
Whereas the documentation to AdminClient, DataClient, and InstanceClient could say:
/** * Normal documentation stuff here. * * @par Cost * Applications should avoid unnecessarily creating new objects of type AdminClient. Creating * a new object of this type typically requires connecting to the Cloud Bigtable servers, and * performing the authentication workflows with Google Cloud Platform. These operations can * take many milliseconds, therefore applications should try to reuse the same AdminClient * instances when possible.*/classAdminClient ...
Activity
Documenting length limits and cost of creating Admin and Client objec…