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.

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

Better code documentation (tsdoc) #1554

Closed
Diluka opened this issue Feb 14, 2019 · 2 comments
Closed

Better code documentation (tsdoc) #1554

Diluka opened this issue Feb 14, 2019 · 2 comments

Comments

@Diluka
Copy link
Contributor

Diluka commented Feb 14, 2019

I'm submitting a...


[ ] Regression 
[ ] Bug report
[ ] Feature request
[x] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Expected behavior

Minimal reproduction of the problem with instructions

What is the motivation / use case for changing the behavior?

Environment


Nest version: X.Y.Z

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

What is this for?

public isExceptionObject(err): err is Error {
return isObject(err) && !!(err as Error).message;
}

There too many APIs without tsdoc comment.

@kamilmysliwiec kamilmysliwiec changed the title lack of tsdoc Better code documentation (tsdoc) Feb 17, 2019
@kamilmysliwiec
Copy link
Member

We started working on it #2688 We'll push more docs shortly

@lock
Copy link

lock bot commented Dec 9, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Dec 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants