yarnpkg/yarn

Documentation: yarn licenses generate-disclaimer wrong description

Open

#3,797 创建于 2017年7月2日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)JavaScript (41,514 star) (2,731 fork)batch import
cat-documentationgood first issuehelp wantedtriaged

描述

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

贡献者指南

技术栈
javascriptnodejs
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
95
研究方向
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.
Documentation: yarn licenses generate-disclaimer wrong description · yarnpkg/yarn#3797 | Good First Issue