Closed Chadowo closed 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!
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.
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 alsosrc/ruby/...
yet since I didn't want this PR to be that big & wanted to get some feedback from you :sweat_smile:Notable Changes
@example
tag for code snippets instead of monospaced formatting. Before: