SocketCluster / SocketCluster/socketcluster-client
[docs] Add description about `autoReconnectOptions` option
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 300
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Please, provide detail info about parameters of autoReconnectOptions option.
Describe whats this parameters do. Current description is confused me and force to explore source code.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by locating the current documentation for the autoReconnectOptions option and compare it with the option's source-level parameters. Expand the documentation so each parameter's purpose is clear; the work is done when readers no longer need to inspect the source to understand the option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100