Skip to content

Make it more discoverable that setting a new timeline doesn't disable previously set timeline(s) #4551

@abey79

Description

@abey79

In our logging API, setting a new timeline with set_log_{time, sequence} does not deactivate a previously set timeline. This must be done with an explicit call to disable_timeline.

This can easily confuse even most experienced users, so it would be great to improve discoverability/onboarding around this notion.

One possible improvement in that regard would be to add a disable_others argument to set_log_{time, sequence}, which, if set to True, would disable other active timeline(s). This could occasionally make the code cleaner in the typical case where, e.g., different data is logged alternatively to two timelines.

Of course, this would only be a very incremental improvement on discoverability, so other such steps would be desirable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request🪵 Log & send APIsAffects the user-facing API for all languages

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions