Fix documentation changes

Now that the documentation checks have its own separate job, resolve the issues brought up by it and remove the cargo doc check from the ubuntu container tests. Signed-off-by: Tomás González <[email protected]>
tgonzalezorlandoarm · Feb 2, 2024 · 0f28992 · 0f28992
1 parent c3d5508
commit 0f28992
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -46,8 +46,6 @@ jobs:
         run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/all-ubuntu.sh
       - name: Run the cross-compilation script
         run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/cross-compile.sh
-      - name: Check the documentation
-        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer cargo doc
 
   tests-ubuntu-v3:
     name: Ubuntu tests on v3.x.y of tpm2-tss

diff --git a/tss-esapi/src/interface_types/session_handles.rs b/tss-esapi/src/interface_types/session_handles.rs
@@ -92,7 +92,7 @@ pub enum AuthSession {
 }
 
 impl AuthSession {
-    /// Function that creates a Option<Session>.
+    /// Function that creates a `Option<Session>`.
     ///
     /// If a Session is created from the NoneHandle
     /// then the returned value from the function will be None.

diff --git a/tss-esapi/src/structures/lists/pcr_selection.rs b/tss-esapi/src/structures/lists/pcr_selection.rs
@@ -52,7 +52,7 @@ impl PcrSelectionList {
         Ok(())
     }
 
-    /// Function for retrieving the PcrSelectionList from Option<PcrSelectionList>
+    /// Function for retrieving the PcrSelectionList from `Option<PcrSelectionList>`
     ///
     /// This returns an empty list if None is passed
     pub fn list_from_option(pcr_list: Option<PcrSelectionList>) -> PcrSelectionList {