yarnpkg/yarn

Documentation: yarn licenses generate-disclaimer wrong description

Open

#3797 opened on Jul 2, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (41,514 stars) (2,731 forks)batch import
cat-documentationgood first issuehelp wantedtriaged

Description

Do you want to request a feature or report a bug? Documentation bug

What is the current behavior? https://yarnpkg.com/en/docs/cli/licenses#toc-yarn-licenses-generate-disclaimer shows in the description:

Running this command will return a sorted list of licenses from all the packages you have installed to the stdout

If the current behavior is a bug, please provide the steps to reproduce. Go to https://yarnpkg.com/en/docs/cli/licenses#toc-yarn-licenses-generate-disclaimer and read the description of the command.

What is the expected behavior? It should read something like: It outputs license template to stdout or similar.

Please mention your node.js, yarn and operating system version. Irrelevant

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Locate the documentation file for the `yarn licenses` CLI command in the repository. The expected output description for `yarn licenses generate disclaimer` should be corrected from 'returns a sorted list of licenses' to 'outputs license template to stdout' or similar. The file is likely in the `docs/` directory; check for a Markdown file named `licenses.md` or similar. The site is static and hosted on yarnpkg.com.