Pete Hayman mrchantey

name	description
rustdoc	Rust documentation conventions (RFC 1574). Apply when writing doc comments on public Rust items. Covers summary sentences, section headings, type references, and examples.

Rust Documentation Conventions (RFC 1574)

Apply these rules when writing doc comments (///) on public Rust items.

Summary Sentence

What is Rust's standard library?

One of the Rust programming language promises is "zero-cost abstraction". Therefore the language itself is pretty conservative about what it incorporates. Types that are basics in other languages, such as string, or features, such as async, cannot be part of the language itself because they are costly abstractions. The user may not need them at all, or he may prefer other alternative implementations. To make those types and functions available nonetheless, they are available as part of the Rust standard library, known as std. Part of this library, known as the prelude is imported by default in each .rs file so you don't have to repeat yourself too much.

Why would you want a `no_std` version of your crate?

Most of the time having this standard library available is not a problem because you run your code on a pretty standard environment: your own computer or a Linux server somewhere in the cloud. However, somet

Intro

The below is a breakdown / bird's eye view of how a sparse-array backed ECS like EnTT or Shipyard works.

Please see the thanks and references at the bottom - without their help I would not have been able to share this breakdown with you... everything here is really just notes and rephrasing of what they've written already :)

Also, these notes do not cover archetype systems (like unity) nor adaptations of archetypes (like in Flecs). Though there's a couple comparative footnotes at the end.

Here we go!

	<!--
	Go to Line 153 for the start of Uniform Buffer Object related code and intro

	Prerequsite:

	You at least know what uniforms are in the context of WebGL
	and mininally understand the concepts involved in creating a square in WebGL
	-->

	<html>

	-- Remove the history from
	rm -rf .git

	-- recreate the repos from the current content only
	git init
	git add .
	git commit -m "Initial commit"

	-- push to the github remote repos ensuring you overwrite history
	git remote add origin git@github.com:<YOUR ACCOUNT>/<YOUR REPOS>.git