Skip to content

Module-style doc strings for examples #3951

@alice-i-cecile

Description

@alice-i-cecile

Every example should have a consistent, basic description of what it does.

IMO, the cleanest way to do this is to use the following style at the beginning of each example .rs file:

//! This example demonstrates how to do something really cool with Bevy
//! Check out all of the [`Structs`] and [`Traits`] it uses

use bevy::prelude::*;
use bevy::ecs::SomethingSpecial;

fn main(){
   App::new()
   .add_system(do_cool_things)
   .run()
}

If you would like to tackle this issue, please go through each example and add / move the description to this format.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-Code-QualityA section of code that is hard to understand or changeC-DocsAn addition or correction to our documentationC-ExamplesAn addition or correction to our examplesD-TrivialNice and easy! A great choice to get started with Bevy

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions