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

example & help files: cleanup and streamlining of server handling #1728

Merged
merged 1 commit into from
Nov 21, 2015
Merged

example & help files: cleanup and streamlining of server handling #1728

merged 1 commit into from
Nov 21, 2015

Conversation

miczac
Copy link
Contributor

@miczac miczac commented Nov 21, 2015

now consistant to s.boot and s.waitForBoot, adapted help text if applicable.
removed .internal for Stethosope, it's not dependent on the internal server anymore.
checked against dowhenbooted, waitforboot, server.internal, server.default and boot.
omitted help files of Debugging-tips, ClientVsServer, asTarget, standalones, Server.

@crucialfelix
Copy link
Member

ah, actually I think its better to leave these as explicit. I thought we were talking about entirely removing s.boot or Server.default.boot from help files. why repeat this over and over again ? There is a button to boot the server.

but to rely on knowing that s is usually / by default set to Server.default is more mysterious.

principal of least surprise: "oh duh, I forgot to turn it on" vs "what the hell is this s thing ? why do these people hide things from me ?"

@telephon
Copy link
Member

if we have s to have a special meaning in interpreter code (and I take that as given), we should also use it in the examples.

"oh dude, look my nice patch: s = Synth(\default, [\freq, 8000]);"

That would be unfortunate ...

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

ok, you lost me here: leave what as explizit? There's a variety of changes in this 49 files.
should we remove s.boot at all? Or what would I change back?

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

@telephon , I took the special meaning as given, also as in "s is set once and for good" (in Main.sc).
As @crucialfelix pointed out in the other thread, either users know what they are doing or use the button.
For a starter I'd recommend to leave s untouched for the time being, if she/he is more advanced side-effects of changing s etc should be clear.
The handling of Server.default etc changes throughout the help pages and I don't experience it as consistent - which IMHO should be the case in a help system.

@telephon
Copy link
Member

I completely agree.

ok, you lost me here: leave what as explizit?
There's a variety of changes in this 49 files.

yes, please change them as you proposed! It was just s.boot that you could leave in.

should we remove s.boot at all?

maybe not (at least this is what I tend toward)

Or what would I change back?

Nothing, I think.

@telephon
Copy link
Member

For a starter I'd recommend to leave s untouched for the time being, if she/he is more advanced side-effects of changing s etc should be clear.

yes!

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

revised HelpSource/Tutorials/Tutorial.schelp

@crucialfelix
Copy link
Member

ok, consistency is best. s is well established I think.

the changes here are fine with me. I just made one note about not using a ~var

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

great, thanks! I'll change that and push again.

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

ok, basically done, but I discovered I stated wrongly when saying at
s = Server.local; // this is done by default at startup of SuperCollider <----
I just cross-checked and in truth in Main.sc it's
// set the 's' interpreter variable to the default server.
interpreter.s = Server.default;
So the above comment is not true ...

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

OT side-note: git-gui (homebrew) crashes when entering a ~ in the commit message field. "copypasta" works though ;)

@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

changed comment on s at startup and pushed again.

now consistant to s.boot and s.waitForBoot, adapted help text if applicable.
removed .internal for Stethosope, it's not dependent on the internal server anymore.
checked against dowhenbooted, waitforboot, server.internal, server.default and boot.
omitted help files of Debugging-tips, ClientVsServer, asTarget, standalones, Server.
@miczac
Copy link
Contributor Author

miczac commented Nov 21, 2015

ok, pushed again ... ;)

telephon added a commit that referenced this pull request Nov 21, 2015
example & help files: cleanup and streamlining of server handling
@telephon telephon merged commit c042f0b into supercollider:master Nov 21, 2015
@telephon
Copy link
Member

thanks again, very welcome.

@miczac
Copy link
Contributor Author

miczac commented Nov 22, 2015

np!

@miczac miczac deleted the mz-server_boot_cleanup branch November 22, 2015 01:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants