Skip to content
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

Help: [skip ci] Getting Started should model correct use of 'out' arg #5137

Merged

Conversation

jamshark70
Copy link
Contributor

Purpose and Motivation

Just saw a question on Facebook where a new user had hardcoded bus 0 into a SynthDef, and then used a feature that assumes the bus will not be hardcoded.

Since the question was coming from a user who had just started, I wondered if our tutorial series was pointing in the right direction about bus usage.

It doesn't. The tutorials throughout write Out.ar(0, ...).

This PR replaces all of those with out arguments (following the convention used throughout the class library).

I can understand why we wanted the tutorial series to start in the simplest possible place. But the question this morning reveals also that users extrapolate principles from our code examples. So I'm proposing this in the interest of improving the code models we give to beginning users.

Types of changes

  • Documentation

To-do list

  • Updated documentation
  • This PR is ready for review

@jamshark70 jamshark70 added the comp: help schelp documentation label Aug 15, 2020
Copy link
Contributor

@mossheim mossheim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks!

@mossheim mossheim merged commit 4375726 into supercollider:develop Aug 17, 2020
@mossheim mossheim moved this from TODO to in progress in Patch release cherry-picks Oct 24, 2020
@mossheim mossheim moved this from in progress to DONE in Patch release cherry-picks Oct 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: help schelp documentation
Development

Successfully merging this pull request may close these issues.

None yet

2 participants