Doc Improvement: log metadata

[george-gca]

Is your feature request related to a problem? Please describe.

A lot of logging functions in comet also support logging metada information (e.g. log_text).

Describe the solution you'd like

It would be nice to address what can be done with this metadata, how it is displayed in the comet interface, what can be done with this information, and how can it be accessed. Adding some screenshots would be much appreciated.

Additional context

For example, the metadata dictionary given to log_text is displayed as additional columns in the experiments' text part, but this information is not provided in the log_text documentation.

[DN6]

Duly noted @george-gca! Thank you for the suggestion. We will work towards adding more context to these methods in our docs

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[dsblank]

This issue is now tracked internally as CM-8716

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[github-actions[bot]]

This issue was closed because it has been stalled for 5 days with no activity.