| Age | Commit message (Collapse) | Author | Lines |
|---|
|
|
|
parsing limitations.
Sundown parses
```
~~~
as a valid codeblock (i.e. mismatching delimiters), which made using
rustdoc on its own documentation impossible (since it used nested
codeblocks to demonstrate how testable codesnippets worked).
This modifies those snippets so that they're delimited by indentation,
but this then means they're tested by `rustdoc --test` & rendered as
Rust code (because there's no way to add `notrust` to
indentation-delimited code blocks). A comment is added to stop the
compiler reading the text too closely, but this unfortunately has to be
visible in the final docs, since that's the text on which the
highlighting happens.
|
|
This theoretically gives rustdoc the ability to render our guides,
tutorial and manual (not in practice, since the files themselves need to
be adjusted slightly to use Sundown-compatible functionality).
Fixes #11392.
|
|
This is useful for code that would be expensive to run or has some kind
of external dependency (e.g. a database or server).
|
|
|
|
|
|
It's too easy to forget the `rust` tag to test something.
Closes #11698
|
|
It's too easy to forget the `rust` tag to have a code example tested, and it's
far more common to have testable code than untestable code.
This alters rustdoc to have only two directives, `ignore` and `should_fail`. The
`ignore` directive ignores the code block entirely, and the `should_fail`
directive has been fixed to only fail the test if the code execution fails, not
also compilation.
|
|
This was previously implemented, and it just needed a snapshot to go through
|
|
We generate documentation into the doc/ directory, so we shouldn't be
intermingling source files with generated files
|
