Documentation on timeout options needs clarification

Open

#167 opened on Aug 28, 2023 13 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 1/5
Estimated time: 1-3 hours
Newbie friendliness: 35/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: typescript
Domain: documentation

Research direction

Start with the timeout documentation referenced by issue #167 and verify the timeout unit from the connector’s existing behavior or source. Update the documentation to state the unit and add an example if supported; done means a reader can tell how to specify timeout values.

Written by the indexing model from the issue text.

Description

documentation

"timeout is the maximum time to execute an operation. It has Buffer type because timestamp in Hive has capacity 64. So for such value, you should use node-int64 npm module."

Right now the documentation just says that the timeout represents "time", but doesn't have any indication of the unit.

Is it the amount of time in milliseconds?
Seconds?
Minutes?

Seems like a pretty easy update to documentation to add in the unit (and potentially an example of setting the timeout).

Dominant language: TypeScript
Stars: 36
Forks: 50
Avg merge: 13h 46m
Merged PRs (30d): 9

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.