diff --git a/src/Nitride.IO/README.md b/src/Nitride.IO/README.md index 6ef044f..2b62695 100644 --- a/src/Nitride.IO/README.md +++ b/src/Nitride.IO/README.md @@ -4,9 +4,9 @@ This assembly contains the primary system for reading and writing from the disk, along with various processes to manipulate paths. It contains three primary components: -- File System I/O -- Path Normalization -- Disk-Based Content +- File System I/O +- Path Normalization +- Disk-Based Content ## File System I/O diff --git a/src/Nitride/Entities/README.md b/src/Nitride/Entities/README.md index 17f320b..519c714 100644 --- a/src/Nitride/Entities/README.md +++ b/src/Nitride/Entities/README.md @@ -48,34 +48,34 @@ Assert.Equal(2, newEntity.Count); The basic operations for entity components are: -- `Add(component)`: Adds a component as the given type. If there is - already a component there, an exception will be thrown. -- `Add(component)`: As `Add(component)` but the `TType` is the same as - `component.GetType()`. -- `Remove()`: Removes any component of the given type, if exists. If - there is no such component, then nothing happens. -- `Remove(component)`: Same as `Remove` with the component given - determining the `TType`. -- `Set(component)`: Adds or updates a component of the given type. -- `Set(component)`: Same as `Set` with the component given determining - the `TType`. -- `Copy()`: Creates a copy of the entity and assigns it a new identifier. -- `ExactCopy()`: Creates a copy of the entity with the same identifier. +- `Add(component)`: Adds a component as the given type. If there is + already a component there, an exception will be thrown. +- `Add(component)`: As `Add(component)` but the `TType` is the same as + `component.GetType()`. +- `Remove()`: Removes any component of the given type, if exists. If + there is no such component, then nothing happens. +- `Remove(component)`: Same as `Remove` with the component given + determining the `TType`. +- `Set(component)`: Adds or updates a component of the given type. +- `Set(component)`: Same as `Set` with the component given determining + the `TType`. +- `Copy()`: Creates a copy of the entity and assigns it a new identifier. +- `ExactCopy()`: Creates a copy of the entity with the same identifier. As above, all of these return a new entity (or the same one if no change is made to the entity). ### Query Components -- `bool Has()`: Returns a value indicating whether the entity has the - given component type. -- `TType Get()`: Returns the value of the registered component. If there - is no such object, this will throw an exception. -- `TType? GetOptional()`: Returns the value of the registered component. - If there is no such object, this will return the default value. -- `bool TryGet(out TType component)`: Attempt to get the component. If it - cannot be retrieved, then this will return `false` and `component` is - undefined. +- `bool Has()`: Returns a value indicating whether the entity has the + given component type. +- `TType Get()`: Returns the value of the registered component. If there + is no such object, this will throw an exception. +- `TType? GetOptional()`: Returns the value of the registered component. + If there is no such object, this will return the default value. +- `bool TryGet(out TType component)`: Attempt to get the component. If it + cannot be retrieved, then this will return `false` and `component` is + undefined. ## Collections diff --git a/src/Nitride/ROADMAP.md b/src/Nitride/ROADMAP.md index b5b2761..0d8e157 100644 --- a/src/Nitride/ROADMAP.md +++ b/src/Nitride/ROADMAP.md @@ -2,8 +2,8 @@ ## Immediate -- Switch the various operations to be async - - ReadFiles - - WriteFiles -- Implement mime type determination -- Implement a convert to text content based on mime type +- Switch the various operations to be async + - ReadFiles + - WriteFiles +- Implement mime type determination +- Implement a convert to text content based on mime type