Skip to content

Documentation and code disagree about default operation timeout #38

@randycoulman

Description

@randycoulman

In the documentation for SFTPClient.Operations.Connect.connect/1, it says that the default :operation_timeout is 5 seconds.

However, in the definition of the Config struct, the default is :infinity.

I'm not sure whether it's the code or the documentation that's wrong. From looking at the commit history, there were two commits on 2025-05-19, both titled "Add operation timeout". The first one defaulted to 5 seconds as documented, but the second one changed it to :infinity without updating the documentation.

Given that, it seems like the default of :infinity is correct and the documentation should be updated?

I'm willing to create a PR to fix this if you can confirm the desired direction.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions