Hey,
I just went thru a bunch of interfaces and noticed a good pattern in
wording. I propose to make this part of the style guide:
rewind - go back to the beginning of a chunk of data (used in: textfile, binfile, msgfile, etc.)
reset - clear the data from a container; or, go back to the initial
state
(used in: zexy/index, cyclone/MouseState, maxlib, etc.)
.hc
"[T]he greatest purveyor of violence in the world today [is] my own
government." - Martin Luther King, Jr.
On Wed, Mar 25, 2009 at 11:38 AM, Hans-Christoph Steiner hans@eds.org wrote:
Hey,
I just went thru a bunch of interfaces and noticed a good pattern in wording. I propose to make this part of the style guide:
rewind - go back to the beginning of a chunk of data (used in: textfile, binfile, msgfile, etc.)
reset - clear the data from a container; or, go back to the initial state (used in: zexy/index, cyclone/MouseState, maxlib, etc.)
thanx, agreed & noted!
.hc
"[T]he greatest purveyor of violence in the world today [is] my own government." - Martin Luther King, Jr.
Pd-list@iem.at mailing list UNSUBSCRIBE and account-management -> http://lists.puredata.info/listinfo/pd-list
Hans-Christoph Steiner wrote:
Hey,
I just went thru a bunch of interfaces and noticed a good pattern in wording. I propose to make this part of the style guide:
rewind - go back to the beginning of a chunk of data (used in: textfile, binfile, msgfile, etc.)
reset - clear the data from a container; or, go back to the initial state (used in: zexy/index, cyclone/MouseState, maxlib, etc.)
"reset" should not be confused with "clear"... what about open vs. read vs. load? marius.
On Mar 25, 2009, at 5:33 PM, marius schebella wrote:
Hans-Christoph Steiner wrote:
Hey, I just went thru a bunch of interfaces and noticed a good pattern
in wording. I propose to make this part of the style guide: rewind - go back to the beginning of a chunk of data (used in: textfile, binfile, msgfile, etc.) reset - clear the data from a container; or, go back to the initial
state (used in: zexy/index, cyclone/MouseState, maxlib, etc.)"reset" should not be confused with "clear"...
Hmm, what's the difference? I think I remember seeing [clear( and
thinking that it should ahve been [reset(.
what about open vs. read vs. load?
That probably should be documented. Make a proposal!
.hc
marius.
As we enjoy great advantages from inventions of others, we should be
glad of an opportunity to serve others by any invention of ours; and
this we should do freely and generously. - Benjamin Franklin
Hallo, Hans-Christoph Steiner hat gesagt: // Hans-Christoph Steiner wrote:
"reset" should not be confused with "clear"...
Hmm, what's the difference? I think I remember seeing [clear( and
thinking that it should ahve been [reset(.
"clear" is used in [pipe]. I guess "clear" is used here because there are two ways to "reset" a [pipe]: One is a reset with outputting all scheduled delays, the other is a "mute" resetting with discarding scheduled delays. The former is called "flush" with [pipe], the latter is called "clear".
With [delay] the "reset" method is called "stop" which sounds natural to me.
Frank