tranek / GASDocumentation

My understanding of Unreal Engine 5's GameplayAbilitySystem plugin with a simple multiplayer sample project.
MIT License
4.39k stars 806 forks source link

Typos fixed, QOL updates. #90

Closed WizardCell closed 1 year ago

WizardCell commented 1 year ago

I spent the last two months reading through GASDocumentation and it was a fun journey. While I was reading, I made sure to notate any typos I found along the way. I barely could find any compared to how monolithic the doc is. Hopefully this PR has covered all the typos!

WizardCell commented 1 year ago

Some of the fixes I did was that I replaced some of the of "GD" prefixes (which stand for GASDocumentation) to "GS" (which stand for (GAS Shooter, i.e. the Sample Project). Maybe I shouldn't have done that, but if you look closely that caused me some confusion as in this case for example:

image

Before it used to say "UGD", and me as a reader was confused to see that the Sample Project uses some other totally different prefix. Let me know what you think regarding that? (I'm asking because in my PR I didn't replace all "GD" prefixes to "GS", which I noticed quite late).

For example, in this case:

image

I didn't replace UGD to UGS because this code doesn't exist at all in the GAS Shooter Sample Project.

tranek commented 1 year ago

Hello,

Thanks for looking into typos. The Sample Project generally refers to the Unreal project included in the GASDocumentation repository https://github.com/tranek/GASDocumentation/tree/master/Source/GASDocumentation. The prefixes for the code snippets should be correct. I understand why it's confusing since the snippets were pulled from many different projects - GD, GS, and even a few PA (my ParagonAssets project that's not public).

WizardCell commented 1 year ago

That makes total sense, thank you for clarifying things for me! I reverted the prefix changes I made, and committed a new PR.

tranek commented 1 year ago

Thank you for doing this! 🙌

WizardCell commented 1 year ago

Actually, thank you Dan for bearing with me through the process! 😄