Fix typos and styling in README.md (50% done) #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
All done, ready for review. |
Byteron
requested changes
Apr 30, 2022
README.md
Outdated
Comment on lines
171
to
173
| // A Trigger! | ||
| // A Trigger! | ||
| // A Trigger! |
There was a problem hiding this comment.
you changed the string, so the output changes too! :D
README.md
Outdated
Comment on lines
189
to
191
| // This also works for "tag" components without any data. | ||
| entity.Add<Old>(); // No trigger. | ||
| entity.Add<Old>(true); // Trigger. |
There was a problem hiding this comment.
this also works with components that have data, but where no initial values are needed.
public struct Purse { public int Value; }
entity.Add<Purse>(); // initialized with Value = 0There was a problem hiding this comment.
this also works with components that have data, but where no initial values are needed.
public struct Purse { public int Value; } entity.Add<Purse>(); // initialized with Value = 0
So it works both for:
- "Tag" components without any data
- Components that have data, but where no initial values are needed
Is this correct?
There was a problem hiding this comment.
Yes, and it also works for components where initial values are needed.
README.md
Outdated
Comment on lines
245
to
246
| // This is called once on Node intialization. | ||
| public override void _Init() |
There was a problem hiding this comment.
This probably needs to be _Ready(), when _Init() is not a thing in C#
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed some typos, styling and matched C# Naming Conventions in README.md as found here: https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions#commenting-conventions
About 50% done, will fix the rest later.