Fix Documentation Grammar In Audio, Core & Top Files

HellRok / Taylor

A simple game engine built using raylib and mruby

https://www.taylormadetech.dev

MIT License

97 stars 6 forks source link

Fix Documentation Grammar In Audio, Core & Top Files #27

Closed Chadowo closed 5 months ago

Chadowo commented 5 months ago

I've noticed that some documentation has missing periods while other hasn't, there are some typos here and there, and generally some other things that can be improved using some YARD features. So this PR aims to address that.

I didn't go ahead and check models/, shapes/ and also src/ruby/... yet since I didn't want this PR to be that big & wanted to get some feedback from you :sweat_smile:

Notable Changes

Usage of the @example tag for code snippets instead of monospaced formatting. Before: After:
Usage of braces to link classes in the docs instead of monospaced formatting.

HellRok commented 5 months ago

This is fantastic but I'm afraid you've picked a really bad time to do this PR! I'm part way through a major refactor which is getting me to overhaul the entirety of the documentation as I go.

I did not know about the @example stuff, I'll definitely start implementing that.

If you're able to rebase this PR against my branch https://github.com/HellRok/Taylor/tree/major-refactor I will give it a proper look over and help you get it merged as I really do appreciate the help.

Thank you so much for this and I'm really sorry I haven't made it super clear I'm in the middle of major changes. I'll actually update the README now so this doesn't happen to anyone else!

Chadowo commented 5 months ago

As it seems, I'm still bad at Git and wasn't able to properly rebase onto major-refactor (-‿-"). I'll see you at new PR to start from a blank slate.