Clarifications (#57)

* Update Managers.md To correct argument for GetControlClass * Update NcObject.md to add paragraph for GetSequenceLength * Update How does it work to help with clarity * Update docs/NcObject.md Co-authored-by: jonathan-r-thorpe <[email protected]> --------- Co-authored-by: jonathan-r-thorpe <[email protected]>
AMWA-TV · Aug 4, 2023 · 3d1861a · 3d1861a
1 parent b4b64ce
commit 3d1861a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Sets out the rules and framework for building control models in NMOS devices.
 
 ### How does it work?
 
-Web IDL definitions and supporting documentation describe the way control models may be created.
+Model definitions and supporting documentation describe the way control models can be created.
 
 ### Other specifications in the suite
 

diff --git a/docs/Managers.md b/docs/Managers.md
@@ -38,7 +38,7 @@ The manager has two properties:
 * controlClasses (lists all class descriptors in the device using the [NcClassDescriptor](Framework.md#ncclassdescriptor) type - descriptors do not contain inherited elements)
 * datatypes (lists all data type descriptors in the device using the [NcDatatypeDescriptor](Framework.md#ncdatatypedescriptor) type - descriptors do not contain inherited elements)
 
-The descriptor for an individual control class can be retrieved using the `GetControlClass` method (`[element("3m1")]`) and passing the identity (type [NcClassId](Framework.md#ncclassid)) and includeInherited (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) as arguments. The method has a response of type [NcMethodResultClassDescriptor](Framework.md#ncmethodresultclassdescriptor).
+The descriptor for an individual control class can be retrieved using the `GetControlClass` method (`[element("3m1")]`) and passing the classId (type [NcClassId](Framework.md#ncclassid)) and includeInherited (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) as arguments. The method has a response of type [NcMethodResultClassDescriptor](Framework.md#ncmethodresultclassdescriptor).
 
 The descriptor for an individual data type can be retrieved using the `GetDatatype` method (`[element("3m2")]`) and passing the name (type [NcName](Framework.md#ncname)) and includeInherited (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) as arguments. The method has a response of type [NcMethodResultDatatypeDescriptor](Framework.md#ncmethodresultdatatypedescriptor).
 

diff --git a/docs/NcObject.md b/docs/NcObject.md
@@ -52,6 +52,9 @@ The result is of type [NcMethodResultId](Framework.md#ncmethodresultid) which co
 Removing an item from a collection is done through the `RemoveSequenceItem` method (\[element("1m6")\]) by specifying the property identifier [NcPropertyId](Framework.md#ncpropertyid) and the index as arguments.
 The result is of type [NcMethodResult](Framework.md#ncmethodresult).
 
+Checking the size of a collection is done through the `GetSequenceLength` method (\[element("1m7")\]) by specifying the property identifier [NcPropertyId](Framework.md#ncpropertyid) as an argument.
+The result is of type [NcMethodResultLength](Framework.md#ncmethodresultlength).
+
 ## Touchpoints
 
 Touchpoints represent the way in which a control model object may expose identity mappings across other contexts.