From 35c6636ce8084441a3eac8647a19c1f75672aa08 Mon Sep 17 00:00:00 2001 From: CoCoSol007 Date: Sat, 10 Feb 2024 00:23:52 +0100 Subject: [PATCH] Update docstring --- crates/border-wars/src/lib.rs | 4 ++-- crates/border-wars/src/menu.rs | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/crates/border-wars/src/lib.rs b/crates/border-wars/src/lib.rs index d967357..a3fbdd3 100644 --- a/crates/border-wars/src/lib.rs +++ b/crates/border-wars/src/lib.rs @@ -9,11 +9,11 @@ pub mod menu; /// The state of the game. #[derive(Debug, Clone, Copy, Default, Eq, PartialEq, Hash, States)] pub enum GameState { - /// The main menu. + /// When we are in the main menu. #[default] Menu, /// The lobby where the host will wait for other players to join. Lobby, - /// The game. + /// When we play this wonderful game. Game, } diff --git a/crates/border-wars/src/menu.rs b/crates/border-wars/src/menu.rs index 11a400e..fb490c2 100644 --- a/crates/border-wars/src/menu.rs +++ b/crates/border-wars/src/menu.rs @@ -21,8 +21,7 @@ impl Plugin for MenuPlugin { ); } } -/// Display a window, with a button to join a game and an input to enter -/// TODO +/// Display the UI of the menu to host a game or join one. fn menu_ui(mut ctx: EguiContexts, mut connection_string: Local) { egui::CentralPanel::default().show(ctx.ctx_mut(), |ui| { ui.heading("Border Wars");