steveklabnik/rustdoc

Flag: crate name

Offen

#132 geöffnet am 10.08.2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen) (22 Forks)github user discovery
E-Mediumbackendhelp wantedquestion

Repository-Metriken

Stars
 (104 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

--crate-name: controlling the name of the crate

Using this flag looks like this:

$ rustdoc src/lib.rs --crate-name mycrate

By default, rustodc assumes that the name of your crate is the same name as the .rs file. --crate-name lets you override this assumption with whatever name you choose.

Should we keep this flag or not?

Contributor Guide

Research-Richtung
Überprüfe das verknüpfte Meta Issue und die Diskussion, um die Gründe für das Behalten oder Entfernen des crate name Flags zu verstehen. Berücksichtige seine Verwendung in rustdoc und mögliche Alternativen.
Tech Stack
rust
Domain
documentationcli
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40