Merge pull request #364 from Foundation-Devices/fix-doctest

Fix xous-rs documentation tests
This commit is contained in:
Sean Cross 2023-04-12 22:45:20 +08:00 committed by GitHub
commit f8cb6811ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -439,15 +439,15 @@ pub enum SysCall {
/// ///
/// ## Arguments /// ## Arguments
/// ///
/// * **Index**: The item to adjust. Currently the following limits /// * **Index**: The item to adjust. Currently the following limits
/// are supported: /// are supported:
/// 1: Maximum heap size /// 1: Maximum heap size
/// 2: Current heap size /// 2: Current heap size
/// * **Current Limit**: Pass the current limit value here. The current /// * **Current Limit**: Pass the current limit value here. The current
/// limit must match in order for the new limit to take /// limit must match in order for the new limit to take
/// effect. This is used to avoid a race condition if two /// effect. This is used to avoid a race condition if two
/// threads try to set the same limit. /// threads try to set the same limit.
/// * **Proposed Limit**: The new value that you would like to use. /// * **Proposed Limit**: The new value that you would like to use.
/// ///
/// ## Returns /// ## Returns
/// ///
@ -455,7 +455,7 @@ pub enum SysCall {
/// ///
/// ## Errors /// ## Errors
/// ///
/// * **InvalidLimit**: The specified index was not valid /// * **InvalidLimit**: The specified index was not valid
AdjustProcessLimit( AdjustProcessLimit(
usize, /* process limit index */ usize, /* process limit index */
usize, /* expected current limit */ usize, /* expected current limit */
@ -488,9 +488,9 @@ pub enum SysCall {
/// ///
/// ## Arguments /// ## Arguments
/// ///
/// * **MessageSender**: This is the `sender` from the message envelope. /// * **MessageSender**: This is the `sender` from the message envelope.
/// It is a unique ID that identifies this message, /// It is a unique ID that identifies this message,
/// as well as the server it came from. /// as well as the server it came from.
/// ///
/// The remaining arguments depend on whether the message was a `BlockingScalar` /// The remaining arguments depend on whether the message was a `BlockingScalar`
/// message or a `MemoryMessage`. Note that this function should NOT be called /// message or a `MemoryMessage`. Note that this function should NOT be called