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

Docs: add docstrings for schematics/utils #314

Closed
rjlopezdev opened this issue Feb 22, 2020 · 2 comments
Closed

Docs: add docstrings for schematics/utils #314

rjlopezdev opened this issue Feb 22, 2020 · 2 comments

Comments

@rjlopezdev
Copy link

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

Currently there aren't docs for this methods.
image

Expected behavior

Add docstrings to improve schematics development experience.
Ex. VSCode feedback with docstring when hover on method.

Minimal reproduction of the problem with instructions

N/A

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

Schematics are becoming so popular. Developers should be notified that Nest contains with some utility functions that can be used for this purpose :)

Environment


Nest version: 6.14.2

 
For Tooling issues:
- Node version:  10.16.3
- Platform:  Mac OS Catalina
@KingDarBoja
Copy link

This is something that is needed on Angular Schematics as well, so developers can construct their own schematics and contribute to either the project or for its own use. A clear example would be a migration schematic based on migration guide docs.

@kamilmysliwiec
Copy link
Member

#1945

@nestjs nestjs locked and limited conversation to collaborators Nov 25, 2024
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

3 participants