Skip to content

Commit 8ff9179

Browse files
authored
chore: fix doctests (#20)
1 parent bd608df commit 8ff9179

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

.github/workflows/pr.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010
- "master"
1111

1212
schedule:
13-
- cron: "0 3 * * 0" # Every sunday at 3am UTC.
13+
- cron: "0 3 * * 0" # Every Sunday at 3am UTC.
1414

1515
env:
1616
CARGO_TERM_COLOR: always
@@ -39,6 +39,9 @@ jobs:
3939
- name: Run tests
4040
run: cargo nextest run --no-fail-fast --hide-progress-bar
4141

42+
- name: Run Doctests
43+
run: cargo test --doc
44+
4245
linting:
4346
needs: build
4447
runs-on: ubuntu-latest

src/analysis.rs

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1172,7 +1172,7 @@ impl<'a> Analysis<'a> {
11721172
/// let options = AnalysisOptions::default();
11731173
/// let mut analysis = Analysis::new(&options);
11741174
///
1175-
/// let result = analysis.analyze_expr(&AnalysisContext::default(), &expr, Type::Number);
1175+
/// let result = analysis.analyze_expr(&mut AnalysisContext::default(), &expr, Type::Number);
11761176
/// assert!(result.is_ok());
11771177
/// ```
11781178
pub fn analyze_expr(
@@ -1724,11 +1724,14 @@ impl<'a> Analysis<'a> {
17241724
///
17251725
/// # Examples
17261726
///
1727-
/// ```ignore
1727+
/// ```
1728+
/// use eventql_parser::Type;
1729+
/// use eventql_parser::prelude::{AnalysisOptions, name_to_type};
1730+
///
17281731
/// let opts = AnalysisOptions::default();
1729-
/// assert_eq!(name_to_type(&opts, "String"), Some(Type::String));
1730-
/// assert_eq!(name_to_type(&opts, "INT"), Some(Type::Number));
1731-
/// assert_eq!(name_to_type(&opts, "unknown"), None);
1732+
/// assert!(matches!(name_to_type(&opts, "String"), Some(Type::String)));
1733+
/// assert!(matches!(name_to_type(&opts, "INT"), Some(Type::Number)));
1734+
/// assert!(name_to_type(&opts, "unknown").is_none());
17321735
/// ```
17331736
pub fn name_to_type(opts: &AnalysisOptions, name: &str) -> Option<Type> {
17341737
if name.eq_ignore_ascii_case("string") {

0 commit comments

Comments
 (0)