yarnpkg/yarn

Documentation: yarn licenses generate-disclaimer wrong description

Open

#3.797 geöffnet am 2. Juli 2017

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (41.514 Stars) (2.731 Forks)batch import
cat-documentationgood first issuehelp wantedtriaged

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95
Research-Richtung
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.