-
| Metadata | |
| -------- | --- |
| Owner(s) | @GuillaumeGomez |
| Team(s) | [rustdoc](https://github.com/rust-lang/rust) |
| Goal document | [2024h2/doc_cfg](https://rust-lang.g…
-
For regular unstable functions, rustdoc shows something like this
![Image](https://github.com/user-attachments/assets/6bed7f26-2633-43e2-93c7-42e8a5919708)
However, for const-unstable functions, all…
-
One of the common review comments in the Linux kernel is that there is a missed intra-doc link. It would be nice to have a lint (or two) to flag these cases automatically. In addition, such a lint wou…
ojeda updated
2 weeks ago
-
the line to change would be in `write_shared.rs:154`:
`cx.shared.fs.write(filename, f.minified())`
this should use `f.bytes` instead of `f.minified()` if the `--no-minify` flag is specified.
th…
-
Running `test_coverage.py` does not take into account doc tests in the coverage, `cargo test` does not run them.
Using `sudo ./tools/devtool shell -p` and running `cargo test` also ignores doc test…
-
We should IMO aim to have integration tests that hit the whole public API before we release `v1.0` versions. Up to now we have been relying on rustdoc tests to give us full API coverage but because of…
-
(disclaimer: I wrote it)
https://github.com/bearcove/merde_json is lighter than serde_json, and could easily replace it for the two places fluke deals with json:
- in httpwg-gen (parsing the J…
-
### Summary
Original issue: #12103
Implementation: #12252
Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#output-format-for-rustdoc
This flag determines the outp…
-
Good documentation is a critical part of promoting adoption from other projects. If users cannot understand how to use our tools, odds are they wont. We should document as much of our public API as po…
-
- [ ] Agree on API documentation style and standard
- [ ] Add reference API documentation on methods of `Filestore`