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.