Skip to content

Commit

Permalink
Italic filenames formatted accordingly (#1259)
Browse files Browse the repository at this point in the history
**Task** Addresses:
#625
Certain pages in the mdbook that display filenames have inconsistent
styling.

The style we want to follow: [the interop
section](https://google.github.io/comprehensive-rust/android/interoperability/java.html)

The current problem: [the RTC
driver](https://google.github.io/comprehensive-rust/exercises/bare-metal/rtc.html)
excercise page.

--
@mgeisler I checked this feature by looking through every page


![work](https://github.com/google/comprehensive-rust/assets/38759997/8affd0c2-71f2-4708-88f6-f63cf3c24efa)
  • Loading branch information
friendlymatthew authored Sep 26, 2023
1 parent 864bb94 commit a492b2f
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
8 changes: 4 additions & 4 deletions src/exercises/bare-metal/compass.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Hints:
Download the [exercise template](../../comprehensive-rust-exercises.zip) and look in the `compass`
directory for the following files.

`src/main.rs`:
_src/main.rs_:

<!-- File src/main.rs -->

Expand All @@ -40,23 +40,23 @@ use microbit::{hal::uarte::{Baudrate, Parity, Uarte}, Board};
}
```

`Cargo.toml` (you shouldn't need to change this):
_Cargo.toml_ (you shouldn't need to change this):

<!-- File Cargo.toml -->

```toml
{{#include compass/Cargo.toml}}
```

`Embed.toml` (you shouldn't need to change this):
_Embed.toml_ (you shouldn't need to change this):

<!-- File Embed.toml -->

```toml
{{#include compass/Embed.toml}}
```

`.cargo/config.toml` (you shouldn't need to change this):
_.cargo/config.toml_ (you shouldn't need to change this):

<!-- File .cargo/config.toml -->

Expand Down
24 changes: 12 additions & 12 deletions src/exercises/bare-metal/rtc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ should write a driver for it.
Download the [exercise template](../../comprehensive-rust-exercises.zip) and look in the `rtc`
directory for the following files.

`src/main.rs`:
_src/main.rs_:

<!-- File src/main.rs -->

Expand All @@ -34,87 +34,87 @@ directory for the following files.
{{#include rtc/src/main.rs:main_end}}
```

`src/exceptions.rs` (you should only need to change this for the 3rd part of the exercise):
_src/exceptions.rs_ (you should only need to change this for the 3rd part of the exercise):

<!-- File src/exceptions.rs -->

```rust,compile_fail
{{#include rtc/src/exceptions.rs}}
```

`src/logger.rs` (you shouldn't need to change this):
_src/logger.rs_ (you shouldn't need to change this):

<!-- File src/logger.rs -->

```rust,compile_fail
{{#include rtc/src/logger.rs}}
```

`src/pl011.rs` (you shouldn't need to change this):
_src/pl011.rs_ (you shouldn't need to change this):

<!-- File src/pl011.rs -->

```rust,compile_fail
{{#include rtc/src/pl011.rs}}
```

`Cargo.toml` (you shouldn't need to change this):
_Cargo.toml_ (you shouldn't need to change this):

<!-- File Cargo.toml -->

```toml
{{#include rtc/Cargo.toml}}
```

`build.rs` (you shouldn't need to change this):
_build.rs_ (you shouldn't need to change this):

<!-- File build.rs -->

```rust,compile_fail
{{#include rtc/build.rs}}
```

`entry.S` (you shouldn't need to change this):
_entry.S_ (you shouldn't need to change this):

<!-- File entry.S -->

```armasm
{{#include rtc/entry.S}}
```

`exceptions.S` (you shouldn't need to change this):
_exceptions.S_ (you shouldn't need to change this):

<!-- File exceptions.S -->

```armasm
{{#include rtc/exceptions.S}}
```

`idmap.S` (you shouldn't need to change this):
_idmap.S_ (you shouldn't need to change this):

<!-- File idmap.S -->

```armasm
{{#include rtc/idmap.S}}
```

`image.ld` (you shouldn't need to change this):
_image.ld_ (you shouldn't need to change this):

<!-- File image.ld -->

```ld
{{#include rtc/image.ld}}
```

`Makefile` (you shouldn't need to change this):
_Makefile_ (you shouldn't need to change this):

<!-- File Makefile -->

```makefile
{{#include rtc/Makefile}}
```

`.cargo/config.toml` (you shouldn't need to change this):
_.cargo/config.toml_ (you shouldn't need to change this):

<!-- File .cargo/config.toml -->

Expand Down
6 changes: 3 additions & 3 deletions src/exercises/concurrency/chat-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ server.

Create a new Cargo project and add the following dependencies:

`Cargo.toml`:
_Cargo.toml_:

<!-- File Cargo.toml -->

Expand Down Expand Up @@ -47,7 +47,7 @@ Copy the following server and client code into `src/bin/server.rs` and
`src/bin/client.rs`, respectively. Your task is to complete these files as
described below.

`src/bin/server.rs`:
_src/bin/server.rs_:

<!-- File src/bin/server.rs -->

Expand All @@ -61,7 +61,7 @@ described below.
{{#include chat-async/src/bin/server.rs:main}}
```

`src/bin/client.rs`:
_src/bin/client.rs_:

<!-- File src/bin/client.rs -->

Expand Down

0 comments on commit a492b2f

Please sign in to comment.