utilities/pueue
utilities/pueue
1
0
Fork 0
mirror of https://github.com/nukesor/pueue synced 2024-09-30 04:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix some doc strings

Browse source
This commit is contained in:
Arne Beer 2024-06-23 14:26:11 +02:00
parent 887dff15be
commit 0d9d5e31f8
No known key found for this signature in database
GPG key ID: CC9408F679023B65
2 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
pueue/src/daemon/network/follow_log.rs
View file

@ -9,7 +9,12 @@ use pueue_lib::network::message::*;
use pueue_lib::network::protocol::{send_message, GenericStream};
use pueue_lib::state::SharedState;
/// Handle the continuous stream of a message.
/// Handle the continuous stream of a some log output.
///
/// It's not actually a stream in the sense of a low-level network stream, but rather a series of
/// `Message::Stream` messages, that each send a portion of new log output.
///
/// It's basically our own chunked stream implementation on top of the protocol we established.
pub async fn handle_follow(
pueue_directory: &Path,
stream: &mut GenericStream,

8
pueue/src/daemon/network/response_helper.rs
View file

@ -6,7 +6,7 @@ use pueue_lib::task::Task;
use crate::daemon::state_helper::LockedState;
/// Check whether the given group exists. Return an failure message if it doesn't.
/// Check whether a given group exists. Return a failure message if it doesn't.
pub fn ensure_group_exists<'state>(
state: &'state mut LockedState,
group: &str,
@ -24,8 +24,8 @@ pub fn ensure_group_exists<'state>(
/// Compile a response for actions that affect several given tasks.
/// These actions can sometimes only succeed for a part of the given tasks.
///
/// That's why this helper exists, which determines based on a given criterion `filter`
/// for which tasks the action succeeded and which tasks failed.
/// That's why this helper exists, which determines for which tasks the action succeeded
/// and which tasks failed, based on a given `filter` criterion.
pub fn task_action_response_helper<F>(
message: &str,
task_ids: Vec<usize>,
@ -41,7 +41,7 @@ where
compile_task_response(message, filtered_tasks)
}
/// Compile a response for instructions with multiple tasks ids
/// Compile a response for instructions with multiple tasks ids.
/// A custom message will be combined with a text about all matching tasks
/// and possibly tasks for which the instruction cannot be executed.
pub fn compile_task_response(message: &str, filtered_tasks: FilteredTasks) -> Message {