Skip to content

Commit 8a054d3

Browse files
committed
Hide function signature on async doctests
1 parent 7d36853 commit 8a054d3

File tree

2 files changed

+50
-50
lines changed

2 files changed

+50
-50
lines changed

src/client.rs

+24-24
Original file line numberDiff line numberDiff line change
@@ -153,16 +153,16 @@ impl Client {
153153
///
154154
/// # Example
155155
/// ```no_run
156-
/// #[tokio::test]
157-
/// async fn test_fetch_runtimes() {
158-
/// let client = piston_rs::Client::new();
156+
/// # #[tokio::test]
157+
/// # async fn test_fetch_runtimes() {
158+
/// let client = piston_rs::Client::new();
159159
///
160-
/// if let Ok(runtimes) = client.fetch_runtimes().await {
161-
/// assert!(!runtimes.is_empty());
162-
/// } else {
163-
/// // There was an error contacting Piston.
164-
/// }
160+
/// if let Ok(runtimes) = client.fetch_runtimes().await {
161+
/// assert!(!runtimes.is_empty());
162+
/// } else {
163+
/// // There was an error contacting Piston.
165164
/// }
165+
/// # }
166166
/// ```
167167
pub async fn fetch_runtimes(&self) -> Result<Vec<Runtime>, Box<dyn Error>> {
168168
let endpoint = format!("{}/runtimes", self.url);
@@ -187,24 +187,24 @@ impl Client {
187187
///
188188
/// # Example
189189
/// ```no_run
190-
/// #[tokio::test]
191-
/// async fn test_execute() {
192-
/// let client = piston_rs::Client::new();
193-
/// let executor = piston_rs::Executor::new()
194-
/// .set_language("rust")
195-
/// .set_version("1.50.0")
196-
/// .add_file(piston_rs::File::default().set_content(
197-
/// "fn main() { println!(\"42\"); }",
198-
/// ));
190+
/// # #[tokio::test]
191+
/// # async fn test_execute() {
192+
/// let client = piston_rs::Client::new();
193+
/// let executor = piston_rs::Executor::new()
194+
/// .set_language("rust")
195+
/// .set_version("1.50.0")
196+
/// .add_file(piston_rs::File::default().set_content(
197+
/// "fn main() { println!(\"42\"); }",
198+
/// ));
199199
///
200-
/// if let Ok(response) = client.execute(&executor).await {
201-
/// assert!(response.compile.is_some());
202-
/// assert!(response.run.is_ok());
203-
/// assert!(response.is_ok());
204-
/// } else {
205-
/// // There was an error contacting Piston.
206-
/// }
200+
/// if let Ok(response) = client.execute(&executor).await {
201+
/// assert!(response.compile.is_some());
202+
/// assert!(response.run.is_ok());
203+
/// assert!(response.is_ok());
204+
/// } else {
205+
/// // There was an error contacting Piston.
207206
/// }
207+
/// # }
208208
/// ```
209209
pub async fn execute(&self, executor: &Executor) -> Result<ExecResponse, Box<dyn Error>> {
210210
let endpoint = format!("{}/execute", self.url);

src/lib.rs

+26-26
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,34 @@
1111
//! ##### Make requests to Piston
1212
//!
1313
//! ```
14-
//! #[tokio::test]
15-
//! async fn example() {
16-
//! let client = piston_rs::Client::new();
17-
//! let executor = piston_rs::Executor::new()
18-
//! .set_language("rust")
19-
//! .set_version("*")
20-
//! .add_file(
21-
//! piston_rs::File::default()
22-
//! .set_name("main.rs")
23-
//! .set_content("fn main() { println!(\"42\"); }"),
24-
//! );
14+
//! # #[tokio::test]
15+
//! # async fn example() {
16+
//! let client = piston_rs::Client::new();
17+
//! let executor = piston_rs::Executor::new()
18+
//! .set_language("rust")
19+
//! .set_version("*")
20+
//! .add_file(
21+
//! piston_rs::File::default()
22+
//! .set_name("main.rs")
23+
//! .set_content("fn main() { println!(\"42\"); }"),
24+
//! );
2525
//!
26-
//! match client.execute(&executor).await {
27-
//! Ok(response) => {
28-
//! if response.is_err() {
29-
//! println!("{}", response.message.unwrap());
30-
//! } else {
31-
//! println!("Language: {}", response.language);
32-
//! println!("Version: {}", response.version);
33-
//! println!("Output:\n{}", response.run.output);
34-
//! }
35-
//! },
36-
//! Err(e) => {
37-
//! println!("Something went wrong contacting Piston.");
38-
//! println!("{}", e);
39-
//! },
40-
//! }
26+
//! match client.execute(&executor).await {
27+
//! Ok(response) => {
28+
//! if response.is_err() {
29+
//! println!("{}", response.message.unwrap());
30+
//! } else {
31+
//! println!("Language: {}", response.language);
32+
//! println!("Version: {}", response.version);
33+
//! println!("Output:\n{}", response.run.output);
34+
//! }
35+
//! },
36+
//! Err(e) => {
37+
//! println!("Something went wrong contacting Piston.");
38+
//! println!("{}", e);
39+
//! },
4140
//! }
41+
//! # }
4242
//! ```
4343
4444
// RIP shrimpie, gone but not forgotten.

0 commit comments

Comments
 (0)