Skip to content

docs: clarify units of parameters like "timeout" #661

Description

@jeffective

Describe the feature

Please clarify in the documentation what the units are for parameters like "timeout" (see session.get), and consider changing them to something like timeout_s (if they are seconds).

Activity

  1. jeffective commented on Jan 8, 2026

    @jeffective
    Author

    from discord: the units are seconds

  2. diogomatsubara commented on Mar 13, 2026

    @diogomatsubara
    Contributor

    @jeffective Changing the function signature would break the API and AFAICT, it's not idiomatic in python. I agree with you that this could be documented better. Would you like to take a stab at fixing that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions