Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Provide documentation comments to jest-types
See original GitHub issue🚀 Feature Proposal
Let’s add Tsdoc compatible comment documentation to the files in jest-types so editors can show documentation for these core types across packages.
Motivation
To lower the barrier of creating environments and other Jest extension libraries.
Example
/**
* Called once the suite has completed or failed.
*/
type SuiteDoneFn = ...
Pitch
This feature deserves to be a part of core so that the documentation is as discoverable as possible.
Other Notes:
Not sure if this is being done already, but it can also be very helpful to library users to include the source TypeScript files with the library and to enable Declaration Maps in tsc so that jumping to documentation can jump to TypeScript files directly.
Issue Analytics
- State:
- Created 4 years ago
- Comments:7
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
I don’t really care about the install size if addings more comments makes things better, so I wouldn’t put too much weight on it. Issue here: #6266
Happy to take a pr for tsdoc! Not sure about including the source, people are complaining about the install size already. Probably worth it, though