nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-06-04 19:29:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for custom_code_classes_in_docs feature

Browse Source
This commit is contained in:
Guillaume Gomez 2023-08-28 15:07:54 +02:00
parent f038f180fd
commit 7c72edf19f
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/doc/rustdoc/src/unstable-features.md
View File

@ -631,7 +631,7 @@ to jump to a type definition.
```rust ```rust
#![feature(custom_code_classes_in_docs)] #![feature(custom_code_classes_in_docs)]
/// ```{class=language-c} /// ```custom,{class=language-c}
/// int main(void) { return 0; } /// int main(void) { return 0; }
/// ``` /// ```
pub struct Bar; pub struct Bar;
@ -641,12 +641,16 @@ The text `int main(void) { return 0; }` is rendered without highlighting in a co
with the class `language-c`. This can be used to highlight other languages through JavaScript with the class `language-c`. This can be used to highlight other languages through JavaScript
libraries for example. libraries for example.
Without the `custom` attribute, it would be generated as a Rust code example with an additional
`language-C` CSS class. Therefore, if you specifically don't want it to be a Rust code example,
don't forget to add the `custom` attribute.
To be noted that you can replace `class=` with `.` to achieve the same result: To be noted that you can replace `class=` with `.` to achieve the same result:
```rust ```rust
#![feature(custom_code_classes_in_docs)] #![feature(custom_code_classes_in_docs)]
/// ```{.language-c} /// ```custom,{.language-c}
/// int main(void) { return 0; } /// int main(void) { return 0; }
/// ``` /// ```
pub struct Bar; pub struct Bar;