Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JSDoc to typings for better DX in IDEs #123

Closed
MarkPollmann opened this issue Jun 21, 2018 · 4 comments
Closed

Add JSDoc to typings for better DX in IDEs #123

MarkPollmann opened this issue Jun 21, 2018 · 4 comments
Labels
help wanted Extra attention is needed

Comments

@MarkPollmann
Copy link
Contributor

Describe the feature you'd like:

If I start typing library functions in VS Code all I see in the IntelliSense tooltip is the import statement:

sad-function

As far as I know this could be easily fixed by adding JSDoc in the typings/index.d.ts file so the developer quickly sees a short overview of what this function does and which parameters are expected.

Suggested implementation:

I can start annotating the exported functions 🙂

Describe alternatives you've considered:

Teachability, Documentation, Adoption, Migration Strategy:
@kentcdodds
Copy link
Member

Sounds good to me!

Though you should know that we no longer export Simulate :)

@kentcdodds kentcdodds added the help wanted Extra attention is needed label Jun 21, 2018
@MarkPollmann
Copy link
Contributor Author

Oops, I confused myself reading the docs and watching your course on FEM in parallel 😅

@kentcdodds
Copy link
Member

My bad 😅

@MarkPollmann
Copy link
Contributor Author

If anyone with more experience in this wants to contribute, feel free to comment here. Else I'm going to take a stab at it on the weekend.

@MarkPollmann MarkPollmann mentioned this issue Jun 24, 2018
Merged
4 tasks
julienw pushed a commit to julienw/react-testing-library that referenced this issue Dec 20, 2018
@ruffle1986
docs: update getByText docs (testing-library#123)
fadab1e 
Closes testing-library#122 

**What**:

`getByText` section in the readme.

**Why**:

The current example is not accurate.

**How**:

Since the `exact` option is true by default, I use a regular exception with ignore case to find the desired element by text.

**Checklist**:

- [X] Documentation
- [ ] Tests N/A
- [X] Ready to be merged
- [X] Added myself to contributors table
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kentcdodds @MarkPollmann