From f932628538fef70077fdeb94032f1593205d0108 Mon Sep 17 00:00:00 2001 From: Pierre Alexandre Tremblay Date: Mon, 21 Dec 2020 17:55:17 +0000 Subject: [PATCH] new interface for DataSet and LabelSet helpfiles --- .../HelpSource/Classes/FluidDataSet.schelp | 17 ++--------------- .../HelpSource/Classes/FluidLabelSet.schelp | 11 +---------- 2 files changed, 3 insertions(+), 25 deletions(-) diff --git a/release-packaging/HelpSource/Classes/FluidDataSet.schelp b/release-packaging/HelpSource/Classes/FluidDataSet.schelp index 7895827..790f42f 100644 --- a/release-packaging/HelpSource/Classes/FluidDataSet.schelp +++ b/release-packaging/HelpSource/Classes/FluidDataSet.schelp @@ -1,7 +1,7 @@ TITLE:: FluidDataSet summary:: Container for labelled, multidimensional data categories:: UGens>FluidManipulation -related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKNN, Classes/FluidKMeans +related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKMeans ​ DESCRIPTION:: A server-side container associating labels with multi-dimensional data. FluidDataSet is identified by its name. @@ -15,20 +15,10 @@ Create a new instance of the DataSet, with the given name. If a DataSet with thi ARGUMENT:: server The link::Classes/Server:: on which to create the data set. -ARGUMENT:: name -A symbol with the name of the DataSet. + ​ returns:: The new instance -METHOD:: at -Retrieves a cached instance of a FluidDataSet with the given name, or returns nil if no such object exists. - -ARGUMENT:: server -The server associated with this DataSet instance. -ARGUMENT:: name -The name of the DataSet to retrieve from the cache. - - INSTANCEMETHODS:: ​ PRIVATE:: init,id,cache @@ -63,9 +53,6 @@ Destroy the object on the server. METHOD:: print Post an abbreviated content of the DataSet in the window by default, but you can supply a custom action instead. -​​ -METHOD:: synth -The internal synth the object uses to communicate with the server returns:: A link::Classes/Synth:: ​ diff --git a/release-packaging/HelpSource/Classes/FluidLabelSet.schelp b/release-packaging/HelpSource/Classes/FluidLabelSet.schelp index a29d3d6..91ee776 100644 --- a/release-packaging/HelpSource/Classes/FluidLabelSet.schelp +++ b/release-packaging/HelpSource/Classes/FluidLabelSet.schelp @@ -13,15 +13,6 @@ METHOD:: new Make a new instance of a label set, uniquely identified by its name. Creating an instance with a name already in use will throw an exception. Use link::Classes/FluidLabelSet#*at:: or free the existing instance. ARGUMENT:: server The link::Classes/Server:: on which to create the label set. -ARGUMENT:: name -symbol with the label set's name. - -METHOD:: at -Retrieve a label set from the cache. -ARGUMENT:: server -The link::Classes/Server:: on which to create the label set. -ARGUMENT:: name -symbol or string with the label set's name. INSTANCEMETHODS:: @@ -30,7 +21,7 @@ PRIVATE:: init, id METHOD:: addLabel Add a label to the label set. -ARGUMENT:: id +ARGUMENT:: identifier symbol or string with the ID for this label. ARGUMENT:: label symbol or string with the label to add.