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

[Request] Document usage of ncurc function options #1233

Closed
3 tasks done
CreativeTechGuy opened this issue Dec 6, 2022 · 2 comments
Closed
3 tasks done

[Request] Document usage of ncurc function options #1233

CreativeTechGuy opened this issue Dec 6, 2022 · 2 comments
Labels

Comments

@CreativeTechGuy
Copy link
Contributor

  • I have searched for similar issues
  • I am using the latest version of npm-check-updates
  • I am using node >= 14.14

Feature Request

There's a lot of very useful advanced options which have no documentation. I was about to create a request but finally found this issue showing that it was already implemented. I never knew about it since it wasn't documented anywhere. There's a lot of examples of these since many of the CLI args have advanced function options. Could there be a section of the README to show an example usage and interface for each of these options? What you posted in this comment is perfect if it was all in one place.

@raineorshine
Copy link
Owner

raineorshine commented Dec 6, 2022

That's a great suggestion. I've added a new section to the README which documents all the Advanced Options.

For what it's worth, both the README and the --help output said Run "ncu --help --target" for details where it provided a description and example of the advanced function options, so technically it's not true that there was no documentation. However, if it's not easily discoverable, it might as well not exist, so I'm glad you reached out. Having it directly in the README should make it much easier for others to see the full range of functionality of npm-check-updates.

@CreativeTechGuy
Copy link
Contributor Author

Wow that was fast! Thank you as always. Looks great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants