steveklabnik/rustdoc

Become flag-compatible with existing rustdoc

Open

#125 opened on Aug 10, 2017

View on GitHub
 (7 comments) (0 reactions) (0 assignees) (22 forks)github user discovery
E-Mediumbackendhelp wantedquestquestion

Repository metrics

Stars
 (104 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

https://github.com/rust-lang/rust/blob/master/src/doc/rustdoc/src/command-line-arguments.md describes the flags that current rustdoc accepts. For each flag, we should:

  1. Decide if we want to keep the flag or not
  2. For the ones we may not keep, implement them, but issue a warning
  3. For the ones we do, implement them!

I'm going to make an isssue per flag, as we should have those discussions individually.

Contributor guide

Research direction
Review each flag from the rustdoc command line arguments documentation, decide if it should be kept, deprecated (with warning), or implemented new, then implement accordingly.
Tech stack
rust
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50