react-component / react-component/input-number

useTouch prop used in "Simple Use Touch" example is not documented in README file

Open
#203 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
323
Forks
188
Avg merge
20h 3m
Merged PRs (30d)
1

Description

http://react-component.github.io/input-number/examples/simple-use-touch.html

In the Simple Use Touch example, there is a prop being used, useTouch. The README file for the repo where the table of props is documented does not include this prop, so there is no description of what it does available in the README file.

Contributor guide

No contributing guide indexed for this repository

First steps

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

Research direction

Start with the Simple Use Touch example at http://react-component.github.io/input-number/examples/simple-use-touch.html and locate the repository README's props table. Determine what the documented useTouch prop does from the example and surrounding project context, then add its description to the table. Done means the README documents useTouch clearly alongside the other props.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.