steveklabnik/rustdoc

Flag: test args

Open

#141 opened on Aug 10, 2017

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

Repository metrics

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

Description

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

--test-args:

Using this flag looks like this:

$ rustdoc src/lib.rs --test --test-args ignored

This flag will pass options to the test runner when running documentation tests. For more, see the chapter on documentation tests.

See also --test.

Should we keep this flag or not?

Contributor guide

Research direction
Research the use of test args flag in rustdoc and decide whether to keep or remove it based on its utility and overlap with other flags.
Tech stack
rust
Domain
documentationdeveloper experience
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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.
70