6

RFC: Add descriptive names to doctests by casey · Pull Request #3311 · rust-lang...

 2 years ago
source link: https://github.com/rust-lang/rfcs/pull/3311
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

@casey casey commented 4 days ago •

edited by ehuss

I wasn't sure if this needed an RFC or not. It's a rather minor feature, however, it is a user-visible change, and since I've already written one, I thought I'd open a PR. Feel free to close it if it doesn't require an RFC.

I did some supporting work on this in rust-lang/rust#78429, which made code block info string parsing only split on , and whitespace, so that an attribute of the form name=foo would be possible, but never followed up with the actual RFC.

This RFC proposes the ability to annotate documentation test code blocks with metadata of the form name=NAME. The given name will be used to identify the documentation test when it is run by the test runner, in addition to the current information of test binary, module, and line number.

For example, this documention test:

```name=arithmetic
assert_eq!(2 + 2, 4);
```

Assuming that it is in crate foo, in file src/lib.rs, in module
bar, on line 37, will produce this output when run:

   Doc-tests foo

running 1 test
test src/lib.rs - bar::arithmetic (line 37) ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

Rendered

lebensterben, ChayimFriedman2, liigo, SOF3, U007D, tmccombs, Ltrlg, runiq, and ssokolow reacted with thumbs up emoji All reactions

report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK