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

[docs] - supercollider/supercollider - supercollider/HelpSource/Classes/Server.schelp - minor attempts at fixing some typos and grammar #3837

Merged
merged 25 commits into from Jul 4, 2018

Conversation

Projects
None yet
5 participants
@tem44
Contributor

tem44 commented Jul 2, 2018

[docs] - supercollider/supercollider - supercollider/HelpSource/Classes/Server.schelp - minor attempts at fixing some typos and grammar

below follows an attempt at:

  • improving the quality of Server.schelp documentation file

my atttempt goes in the the direction of fixing issues related to:

  • typing
  • words mispelling
  • grammar
  • syntax
  • puntuation
  • other issues

i acknowledge that:

  • the document may need some bugs to be fixed;
  • my contribution may need some revisions;
  • i may have accidentaly broken some community guidelines (currently contrbuting to several projects);

if that is the case:

  • be honest
  • don't hesitate in telling me what you think
  • i will make sure i will fix everything to meet our standards

looking forward
kind regards/ best wishes
T.


[docs] - supercollider/supercollider - supercollider/HelpSource/Class…
…es/Server.schelp - minor attempts at fixing some typos and grammar

[docs] - supercollider/supercollider - supercollider/HelpSource/Classes/Server.schelp - minor attempts at fixing some typos and grammar
@telephon

telephon requested changes Jul 2, 2018 edited

The additions of "the" are wrong. (Much more than I noted)

@@ -5,7 +5,7 @@ related:: Classes/ServerOptions, Reference/Server-Architecture, Reference/Server
description::
A Server object is a representation of a server application. It is used to control scsynth (or supernova) from the SuperCollider language. (See link::Guides/Server-Guide::, as well as link::Guides/ClientVsServer:: for more details on the distinction.) It forwards OSC messages and has a number of allocators that keep track of IDs for nodes, buses and buffers.
A Server object is a representation of a server application. It is used to control scsynth (or supernova) from the SuperCollider language. (See link::Guides/Server-Guide::, as well as a link::Guides/ClientVsServer:: for more details on the distinction.) It forwards OSC messages and has a number of allocators that keep track of IDs for nodes, buses, and buffers.

This comment has been minimized.

@telephon

telephon Jul 2, 2018

Member

why "See Server-Guide, as well as "a" ClientVsServer"? I think you mistake the link:: tag for a word in the helpfile.

@@ -39,29 +39,29 @@ argument:: name
a symbol; each Server object is stored in one global classvariable under its name.
argument:: addr
an optional instance of link::Classes/NetAddr::, providing host and port.
an optional instance of the link::Classes/NetAddr::, providing host and port.

This comment has been minimized.

@telephon

telephon Jul 2, 2018

Member

we usually say "an instance of NetAddr" and not: "an instance of the NetAddr".

@@ -162,7 +162,7 @@ s.sendBundle(0.2, ["/s_new", "default", x = s.nextNodeID, 0, 1], ["/n_set", x, "
method:: sendRaw
method:: listSendMsg
as sendMsg, but takes an array as argument.
as sendMsg, but takes an array as an argument.

This comment has been minimized.

@telephon

telephon Jul 2, 2018

Member

we usually say "a method takes something as argument".

@@ -237,7 +237,7 @@ argument::onFailure
A function that is called when quit has failed.
argument::watchShutDown
a boolean to tell the server whether to watch status during shutdown.
a boolean to tell the server whether to watch status during the shutdown.

This comment has been minimized.

@telephon

telephon Jul 2, 2018

Member

"during shutdown" is correct.

@@ -273,7 +273,7 @@ Return an array mapping client IDs to their associated default groups as
link::Classes/Group:: objects.
method:: volume
Get an instance of Volume that runs after the default group, or sets the Volume of the Server's output to level. Level is in db.
Get an instance of Volume that runs after the default group, or sets the Volume of the Server's output to level. The level is in db.

This comment has been minimized.

@telephon

telephon Jul 2, 2018

Member

When we write "level is in db" we mean that the parameter is in db. This was correct.

@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 2, 2018

dear @telephon

thank you so much for your precious insight

i will make sure to:

  • review the proposed changes today

looking forward
thank you so much
T.

tem44 added some commits Jul 2, 2018

fixing line 8
fixing line 8
fixing line 42
fixing line 42
fixing line 165
fixing line 165
fixing line 240
fixing line 240
fixing line 276
fixing line 276
@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 2, 2018

dear @telephon fixed all your provided insight shall anyone provide any further feedback? please let me know what you think, and may we proceed with merging PR as soon further people have verified it

@muellmusik muellmusik self-assigned this Jul 2, 2018

method:: remote
Create a new Server instance corresponding to a server app running on a separate machine. This method assumes the remote app has been booted, and starts listening immediately. You should not call link::#-boot:: on an instance created using this method.
Create a new Server instance corresponding to a server app running on a separate machine. This method assumes the remote app has been booted and starts listening immediately. You should not call link::#-boot:: on an instance created using this method.
argument:: name
a symbol; each Server object is stored in one global classvariable under its name.
argument:: addr

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Remove the before NetAddr. Add the before IP address and port.

This comment has been minimized.

@tem44

tem44 Jul 3, 2018

Contributor

fixed

@@ -91,14 +91,14 @@ Server.all
::
method:: allRunningServers
returns:: a Set containing all running servers, according to the definition of link::#-serverRunning::.
returns:: a Set containing all running servers, according to the definition of the link::#-serverRunning::.
code::
Server.allRunningServers

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Remove the before serverrunning

code::
Server.allRunningServers
::
method:: allBootedServers
returns:: a Set containing all booted servers, according to the definition of link::#-hasBooted::.
returns:: a Set containing all booted servers, according to the definition of the link::#-hasBooted::.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Remove the before hasBooted

@@ -153,7 +153,7 @@ method:: sendBundle
send an OSC-bundle to the server.
discussion::
Since the network may have irregular performance, time allows for the bundle to be evaluated at a specified point in the future.
Thus all messages are synchronous relative to each other, but delayed by a constant offset.
Thus all messages are synchronous relative to each other but delayed by a constant offset.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

This is more a question of style than correctness, but personally I prefer it with the comma

@@ -222,10 +222,10 @@ If true, start a Routine to send a /status message to the server every so often.
argument:: recover
If true, create a new node ID allocator for the server, but use the old buffer and bus allocators. This is useful if the server process did not actually stop. In normal use, the default value "false" should be used.
argument:: onFailure
In this method, the onFailure argument is for internal use only. If you wish to take specific actions when the server boots or fails to boot, it is recommended to use link::#-waitForBoot:: or link::#-doWhenBooted::.
In this method, the onFailure argument is for internal use only. If you wish to take specific actions when the server boots or fails to boot, it is recommended to use the link::#-waitForBoot:: or link::#-doWhenBooted::.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Remove the added the

@@ -489,7 +489,7 @@ set the number of shared control buses. Must be done before the internal server
subsection:: Persistent Node Trees
The class link::Classes/ServerTree:: can be used to store functions which will be evaluated after the server is booted, after all nodes are freed, and after cmd-. is pressed.
The class link::Classes/ServerTree:: can be used to store functions which will be evaluated after the server is booted, after all, nodes are freed, and after cmd-. is pressed.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Remove comma after all

@@ -621,12 +621,12 @@ x.free; // stop the synths
// look in your recordings folder and you'll find a file named for this date and time
::
Recording is done via an of link::Classes/Recorder:: - a server holds one instance implicitly.
The recording is done via an of the link::Classes/Recorder:: - a server holds one instance implicitly.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

An instance of recorder

@@ -653,13 +653,13 @@ method:: pauseRecording
Pauses recording. Can be resumed by executing record again.
method:: stopRecording
Stops recording, closes the file, and frees the associated resources.
Stops recording closes the file and frees the associated resources.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

This was correct

discussion::
You must call this when finished recording or the output file will be unusable. Cmd-. while recording has the same effect.
method:: recChannels
Get/set the number of channels (int) to record. Is automatically set to the value of link::Classes/ServerOptions#-numOutputBusChannels:: when booting the server. Must be called strong::before:: prepareForRecord.
Get/set the number of channels (int) to record. Is automatically set to the value of the link::Classes/ServerOptions#-numOutputBusChannels:: when booting the server. Must be called strong::before:: prepareForRecord.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

This was correct

method:: bootSync
Boot the Server and wait until it has completed before resuming the thread.
argument:: condition
an optional instance of link::Classes/Condition:: used for evaluating this.
an optional instance of the link::Classes/Condition:: used for evaluating this.

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Remove added the

This comment has been minimized.

@muellmusik

muellmusik Jul 2, 2018

Contributor

Also in similar cases below

tem44 added some commits Jul 3, 2018

fixing line 680
fixing line 680
fixing line 662
fixing line 662
fixing line 656
fixing line 656
fixing line 624
fixing line 624
fixing line 492
fixing line 492
fixing line 156
fixing line 156
fixing line 101
fixing line 101
fixing line 94
fixing line 94
fixing line 58
fixing line 58
@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 3, 2018

dear @muellmusik

  • thanks for the precious insight on my review within the context of the current PR

shall we proceed with merging the PR or shall we listen to what others have to say about the contribution? @miguel-negrao what do you think? can you perharps provide some insight?

thank you so much
kind regards

tem44 added some commits Jul 3, 2018

fixing line 342
fixing line 342
fixing line 372
fixing line 372
fixing line 258
fixing line 258
thanks scott
fixing line 357
fixing line 357
fixing line 357
fixing line 357
fixing spacing
fixing spacing
fixing spacing in line 445
fixing spacing in line 445
fixing line 445
fixing line 445
@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 3, 2018

spent some extra time fixing some other issues that needed to be fixed, among them:

  • unnecessary pronouns before class linking, et. al;
  • unnecessary space modification

I wasn't able to fix the space vs tab in line 471, I guess, so if someone can fix that for me, I would be quite thankful shall we proceed with merging, or shall we wait for others to give further feedback. @telephon, please provide some feedback, if possible

looking forward
kind regards/best wishes
T.

@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 3, 2018

by the way, is it possible to add the label docs to the PR? can someone please do that?

thank you so much

@jamshark70

This comment has been minimized.

Contributor

jamshark70 commented Jul 3, 2018

Tmm, can you please learn to use git so that you can address feedback with one or two commits instead of 20?

The commit history for this pull request is far out of proportion to the content changed. (True, it can be squash-merged later, but the current way also means you've generated literally 20 emails to every developer for a few lines worth of changes. That's really a lot. I don't want my inbox flooded for trivial documentation changes.)

IMO the Edit button in github is not the ideal way to do things. You should be editing local files on your machine, committing locally, and pushing to a branch that you own.

@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 3, 2018

sure, I will start to commit to my local branch and then getting it to the central repository. I will try not to repeat the same mistake again. for some reason, I tend to work in this sort of way, so yeah, it might be not ok for you guys. I already have my own shell scripts for dealing with my very own repository managemente, but if i update them and try to get them a bit further, this will probably speed up the pace with which i make my own contributions, and making it more organized and also not so messy. thanks for the precious insight, @jamshark70 I will handle this when I arrive home

@tem44

This comment has been minimized.

Contributor

tem44 commented Jul 3, 2018

this is what I need towards updating my branch with the remote repo of the main supercollider distro, right? at least bearing in mind that this is a shell shortcut.

git remote -v && git remote add upstream $1 && git remote -v && git fetch upstream && git merge upstream/master && git push origin master

for pushing to my local repository, I shall use something like:

VAR1=$(pwgen 10 1) && VAR2=$(date +%Y-%m-%d) && VAR3="$1" && VARF=("$VAR2-$VAR1-$VAR3") && git pull  && git status && git add . && git status && git commit -m "$VARF"  && git status && git checkout -b "$VARF" && git push origin "$VARF" && git status && clear && git-issues

the git issues is a node.js formula that I installed from npm repository

then from that point, I make a pull request to the central repository

and then from that point bearing in mind that the repository I am pulling to a remote repository updating the branch where I created my repository should update the Pull Request. is that right?

@jamshark70

This comment has been minimized.

Contributor

jamshark70 commented Jul 3, 2018

I'd recommend to discuss git workflow questions on the sc-dev mailing list.

I wouldn't automate the steps. If there is a merge conflict, your script will break. If you're bringing in commits from the wrong branch (which everyone does sometimes -- no matter how careful you are, you will mess up a branch at times), and everything is automated, then you'll eventually push commits that you didn't want.

Every step that modifies the repository, do it individually and check the result before moving forward.

@snappizz snappizz added the comp: help label Jul 4, 2018

@snappizz snappizz merged commit ac73b75 into supercollider:develop Jul 4, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@snappizz

This comment has been minimized.

Member

snappizz commented Jul 4, 2018

i have squash merged this so the 20 commits are combined into 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment