Skip to content

Commit 0f28992

Browse files
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]>
1 parent c3d5508 commit 0f28992

File tree

3 files changed

+2
-4
lines changed

3 files changed

+2
-4
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ jobs:
4646
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
4747
- name: Run the cross-compilation script
4848
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
49-
- name: Check the documentation
50-
run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer cargo doc
5149

5250
tests-ubuntu-v3:
5351
name: Ubuntu tests on v3.x.y of tpm2-tss

tss-esapi/src/interface_types/session_handles.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ pub enum AuthSession {
9292
}
9393

9494
impl AuthSession {
95-
/// Function that creates a Option<Session>.
95+
/// Function that creates a `Option<Session>`.
9696
///
9797
/// If a Session is created from the NoneHandle
9898
/// then the returned value from the function will be None.

tss-esapi/src/structures/lists/pcr_selection.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ impl PcrSelectionList {
5252
Ok(())
5353
}
5454

55-
/// Function for retrieving the PcrSelectionList from Option<PcrSelectionList>
55+
/// Function for retrieving the PcrSelectionList from `Option<PcrSelectionList>`
5656
///
5757
/// This returns an empty list if None is passed
5858
pub fn list_from_option(pcr_list: Option<PcrSelectionList>) -> PcrSelectionList {

0 commit comments

Comments
 (0)