Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-11-13 06:54:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clean functions docs.

Browse Source
This commit is contained in:
jcamiel 2023-04-28 11:14:14 +02:00
parent 6379aa788f
commit 7887248dca
No known key found for this signature in database
GPG Key ID: 07FF11CFD55356CC
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
packages/hurl/src/runner/hurl_file.rs
View File

@ -37,7 +37,6 @@ use crate::util::logger::{Logger, LoggerBuilder};
///
/// ```
/// use std::collections::HashMap;
/// use std::path::PathBuf;
/// use hurl::runner;
/// use hurl::runner::{Value, RunnerOptionsBuilder, Verbosity};
/// use hurl::util::logger::LoggerBuilder;
@ -49,7 +48,7 @@ use crate::util::logger::{Logger, LoggerBuilder};
/// "#;
///
/// // Define runner options and logger
/// let runner_options = RunnerOptionsBuilder::new()
/// let options = RunnerOptionsBuilder::new()
/// .follow_location(true)
/// .verbosity(Some(Verbosity::Verbose))
/// .build();
@ -59,14 +58,14 @@ use crate::util::logger::{Logger, LoggerBuilder};
/// let mut variables = HashMap::default();
/// variables.insert("name".to_string(), Value::String("toto".to_string()));
///
/// // Run the Hurl file
/// let hurl_result = runner::run(
/// // Run the Hurl sample
/// let result = runner::run(
/// content,
/// &runner_options,
/// &options,
/// &variables,
/// &logger
/// );
/// assert!(hurl_result.unwrap().success);
/// assert!(result.unwrap().success);
/// ```
pub fn run(
content: &str,

2
packages/hurl_core/src/parser/reader.rs
View File

@ -24,7 +24,7 @@ use crate::ast::Pos;
/// The `Reader` implements methods to read a stream of text. A reader manages
/// an internal `state` which is the position of the current cursor within the reader's buffer.
/// Methods like [`Reader::read`], [`Reader::read_while`], [`Reader::read_while_escaping`]
/// do advance the internal reader's`state`. Other methods, like [`Reader::peek`], [`Reader::peek_k`]
/// do advance the internal reader's`state`. Other methods, like [`Reader::peek`], [`Reader::peek_n`]
/// allows to get the next chars in the buffer without modifying the current reader state.
///
/// # Example