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

Already on GitHub? Sign in to your account

Document the 'depth' argument for `npm-ls'. #4447

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
4 participants
Contributor

fcuny commented Jan 8, 2014

No description provided.

Member

timoxley commented Jan 9, 2014

Member

domenic commented Jan 11, 2014

This is already documented in npm-config.md. I am not sure what our policy is on duplicate docs.

Member

timoxley commented Jan 11, 2014

@domenic probably makes sense to document a command's supported args with the command. The current npm help ls lists a bunch of arguments which too are documented in npm-config.md:

CONFIGURATION
   json
       o   Default: false

       o   Type: Boolean



       Show information in JSON format.

   long
       o   Default: false

       o   Type: Boolean



       Show extended information.

   parseable
       o   Default: false

       o   Type: Boolean



       Show parseable output instead of tree view.

   global
       o   Default: false

       o   Type: Boolean



       List packages in the global install prefix instead of in the current project.

Another argument for documenting it on the command itself is that you can't actually reach npm-config.md via npm help.

I had to find this feature via: http://stackoverflow.com/a/16704412/1585343

Was surprised to see that it is not documented via the website or in npm help list or npm help ls

Member

domenic commented Feb 8, 2014

Merged as 8e4fa63, thanks and sorry for the delay.

@domenic domenic closed this Feb 8, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment