-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix typos and styling in README.md (50% done) #17
Conversation
All done, ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a few minor nitpicks, otherwise good changes!
README.md
Outdated
// A Trigger! | ||
// A Trigger! | ||
// A Trigger! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you changed the string, so the output changes too! :D
README.md
Outdated
// 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, and it also works for components where initial values are needed.
README.md
Outdated
// This is called once on Node intialization. | ||
public override void _Init() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This probably needs to be _Ready(), when _Init() is not a thing in C#
Thanks! |
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.