Skip to content

feat: implement OpenAPI documentation (#162) #230

feat: implement OpenAPI documentation (#162)

feat: implement OpenAPI documentation (#162) #230

GitHub Actions / clippy failed Jul 11, 2024 in 0s

clippy

3 errors

Details

Results

Message level Amount
Internal compiler error 0
Error 3
Warning 0
Note 0
Help 0

Versions

  • rustc 1.79.0 (129f3b996 2024-06-10)
  • cargo 1.79.0 (ffa9cf99a 2024-06-03)
  • clippy 0.1.79 (129f3b9 2024-06-10)

Annotations

Check failure on line 158 in src/server/run/mod.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
   --> src/server/run/mod.rs:158:18
    |
158 | /// Utoipa-based OpenAPI generation helper.
    |                  ^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
    = note: `#[deny(clippy::doc_markdown)]` implied by `#[deny(clippy::pedantic)]`
help: try
    |
158 | /// Utoipa-based `OpenAPI` generation helper.
    |                  ~~~~~~~~~

Check failure on line 104 in src/server/run/hpo_terms.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function which may panic missing `# Panics` section

error: docs for function which may panic missing `# Panics` section
   --> src/server/run/hpo_terms.rs:97:5
    |
97  | /     pub fn from_term_with_ontology(
98  | |         term: &HpoTerm,
99  | |         ontology: &Ontology,
100 | |         genes: bool,
...   |
103 | |         doc: Option<&tantivy::Document>,
104 | |     ) -> Self {
    | |_____________^
    |
note: first possible panic found here
   --> src/server/run/hpo_terms.rs:105:29
    |
105 |           let field_term_id = index
    |  _____________________________^
106 | |             .schema()
107 | |             .get_field("term_id")
108 | |             .expect("field must exist");
    | |_______________________________________^
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc

Check failure on line 104 in src/server/run/hpo_omims.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function which may panic missing `# Panics` section

error: docs for function which may panic missing `# Panics` section
   --> src/server/run/hpo_omims.rs:100:5
    |
100 | /     pub fn from_omim_disease_with_ontology(
101 | |         omim_disease: &OmimDisease,
102 | |         ontology: &Ontology,
103 | |         hpo_terms: bool,
104 | |     ) -> Self {
    | |_____________^
    |
note: first possible panic found here
   --> src/server/run/hpo_omims.rs:115:32
    |
115 |                     let term = term.expect("filtered above");
    |                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc
note: the lint level is defined here
   --> src/main.rs:2:9
    |
2   | #![deny(clippy::pedantic)]
    |         ^^^^^^^^^^^^^^^^
    = note: `#[deny(clippy::missing_panics_doc)]` implied by `#[deny(clippy::pedantic)]`