Skip to content

Commit 9cae5c5

Browse files
committed
docs: enhance code documentation for setup_server function
- add detailed comments to the `setup_server` function - specify the purpose of the `intersections` parameter in the `setup_server` function
1 parent 7960f67 commit 9cae5c5

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

mithril-common/src/chain_observer/pallas_observer.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,11 @@ mod tests {
602602
TempDir::create_with_short_path("pallas_chain_observer_test", folder_name)
603603
}
604604

605-
/// Sets up a mock server.
605+
/// Sets up a mock server for related tests.
606+
///
607+
/// Use the `intersections` parameter to define exactly how many
608+
/// local state queries should be intersepted by the `mock_server`
609+
/// and avoid any panic errors.
606610
async fn setup_server(socket_path: PathBuf, intersections: u32) -> tokio::task::JoinHandle<()> {
607611
tokio::spawn({
608612
async move {

0 commit comments

Comments
 (0)