From 3d0da6df2d4cdbca5949c09abed3770bd34165f2 Mon Sep 17 00:00:00 2001 From: Robert Garrett Date: Sat, 9 Aug 2025 14:54:15 -0500 Subject: [PATCH] Fix module-level docstring in asteroids & config I made a comment to help me remember the purpose, but if I do it this way `cargo doc` will render it out to the actual documentation. --- src/asteroids.rs | 5 +++-- src/config.rs | 6 ++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/asteroids.rs b/src/asteroids.rs index f37d909..c81cfaf 100644 --- a/src/asteroids.rs +++ b/src/asteroids.rs @@ -1,9 +1,10 @@ +//! This is the module containing all the rock-related things. +//! Not... not the whole game. + use bevy_rapier2d::prelude::*; use rand::{Rng, SeedableRng}; use std::time::Duration; -/// This is the module containing all the rock-related things -/// not... not the whole game. use bevy::prelude::*; use crate::{GameAssets, Rotation, WorldSize, physics::Position, physics::Velocity}; diff --git a/src/config.rs b/src/config.rs index 9f0aa61..bfc8fb8 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,7 +1,5 @@ -/* - Global constants used all over the program. Rather than leaving them scattered -where ever they happen to be needed, I'm concentrating them here. -*/ +//! Global constants used all over the program. Rather than leaving them scattered +//! where ever they happen to be needed, I'm concentrating them here. use bevy::color::Color;