supercollider
supercollider copied to clipboard
Docs: Buffer: code style update
Purpose and Motivation
This is a trivial documentation style change to illustrate the PR process for a tutorial. So I might as well submit it :)
Types of changes
- Documentation
To-do list
- [x] Code is tested
- [x] All tests are passing
- [x] Updated documentation
- [x] This PR is ready for review
Thanks for the close look @JordanHendersonMusic, I admittedly just quickly expanded the scope from the tutorial example of fixing function spacing and keywords in a couple methods to the whole file.
But you've motivated me to fix (hopefully) all the code style issues, so I've done the ones you spotted and a bunch more :)
all the code style issues
Across all the docs? ...that sounds like a herculean task! Might be worth asking on the forum if other people might be interested in take a file or two - good chance to get some new contributors?
Do you think I should merge this? The wiki says a third person isn't needed in the case of doc changes like this, and that new reviewers shouldn't merge (which I am).
Across all the docs?
Haha no... just this one file in this case. But funny you should mention it, I have slipped down a bit of a rabbit hole with search and replace throughout the docs and it seems somewhat feasible. I've already swept a few rules through a few hundred files—it's not foolproof, and not fully automatic, but doable I think. If it's looking ok after a bit more hacking, I may post it as a PR just for feedback to gauge interest.
Do you think I should merge this?
Let's hold off for now, I think "Trusted Reviewers" are the ones that merge (I don't do this myself). I've been meaning to post a question on the forum Development Topic to get some clarity on these procedures (and update the wiki with the info...)
Thanks for catching those! Updated.
Since there are two approvals on this, I'll go rogue and merge my own PR 😈