diff --git a/examples/reference/Boolean/.property.yml b/examples/reference/Boolean/.property.yml deleted file mode 100644 index af4bb8e..0000000 --- a/examples/reference/Boolean/.property.yml +++ /dev/null @@ -1,14 +0,0 @@ -category: Data -subcategory: Primitive -description: " -Datatype for the Boolean values True and False. It is common to use boolean values with control statements to determine the flow of a program. The first time a variable is written, it must be declared with a statement expressing its datatype. -" -syntax: "var = booleanValue" -parameters: - - label: 'var' - description: "variable name referencing the value" - - label: 'booleanValue' - description: "True or False" -related: - - True - - False diff --git a/examples/reference/Table/.property.yml b/examples/reference/Table/.property.yml deleted file mode 100644 index c09c137..0000000 --- a/examples/reference/Table/.property.yml +++ /dev/null @@ -1,10 +0,0 @@ -category: Data -subcategory: Composite -description: " -Table objects store data with multiple rows and columns, much like in a traditional spreadsheet. Tables can be generated from scratch, dynamically, or using data from an existing file. Tables can also be output and saved to disk, as in the example above. -" -syntax: "" -related: - - loadTable - - saveTable - - TableRow diff --git a/examples/reference/TableRow/.property.yml b/examples/reference/TableRow/.property.yml deleted file mode 100644 index 95a36d8..0000000 --- a/examples/reference/TableRow/.property.yml +++ /dev/null @@ -1,13 +0,0 @@ -category: Data -subcategory: Composite -description: " -A TableRow object represents a single row of data values, stored in columns, from a table. -" -syntax: "" -related: - - Table - - Table_addRow - - Table_removeRow - - Table_clearRows - - Table_getRow - - Table_rows diff --git a/examples/reference/TableRow_getFloat/.property.yml b/examples/reference/TableRow_getFloat/.property.yml deleted file mode 100644 index e17e5c6..0000000 --- a/examples/reference/TableRow_getFloat/.property.yml +++ /dev/null @@ -1,14 +0,0 @@ -category: TableRow -subcategory: Method -description: " -Retrieves a float value from the TableRow's specified column. The column may be specified by either its ID or title. -" -syntax: ".getFloat(column)\n.getFloat(columnName)" -parameters: - - label: 'column' - description: "int: ID number of the column to reference" - - label: 'columnName' - description: "String: title of the column to reference" -related: - - XML_getInt - - XML_getString diff --git a/examples/reference/TableRow_getInt/.property.yml b/examples/reference/TableRow_getInt/.property.yml deleted file mode 100644 index ae22e3b..0000000 --- a/examples/reference/TableRow_getInt/.property.yml +++ /dev/null @@ -1,14 +0,0 @@ -category: TableRow -subcategory: Method -description: " -Retrieves an integer value from the TableRow's specified column. The column may be specified by either its ID or title. -" -syntax: ".getInt(column)\n.getInt(columnName)" -parameters: - - label: 'column' - description: "int: ID number of the column to reference" - - label: 'columnName' - description: "String: title of the column to reference" -related: - - XML_getFloat - - XML_getString diff --git a/examples/reference/TableRow_getString/.property.yml b/examples/reference/TableRow_getString/.property.yml deleted file mode 100644 index 42a570f..0000000 --- a/examples/reference/TableRow_getString/.property.yml +++ /dev/null @@ -1,14 +0,0 @@ -category: TableRow -subcategory: Method -description: " -Retrieves a String value from the TableRow's specified column. The column may be specified by either its ID or title. -" -syntax: ".getString(column)\n.getString(columnName)" -parameters: - - label: 'column' - description: "int: ID number of the column to reference" - - label: 'columnName' - description: "String: title of the column to reference" -related: - - XML_getInt - - XML_getFloat diff --git a/examples/reference/TableRow_setFloat/.property.yml b/examples/reference/TableRow_setFloat/.property.yml deleted file mode 100644 index 0e5a950..0000000 --- a/examples/reference/TableRow_setFloat/.property.yml +++ /dev/null @@ -1,22 +0,0 @@ -category: TableRow -subcategory: Method -description: " -Stores a float value in the TableRow's specified column. The column may be specified by either its ID or title. -" -syntax: ".setFloat(row, column, value)\n.setFloat(row, columnName, value)" -parameters: - - label: 'row' - description: "int: ID number of the target row" - - label: 'column' - description: "int: ID number of the target column" - - label: 'value' - description: "float: value to assign" - - label: 'columnName' - description: "String: title of the target column" -related: - - XML_setInt - - XML_setString - - XML_getInt - - XML_getFloat - - XML_getString - - Table_getStringColumn diff --git a/examples/reference/TableRow_setInt/.property.yml b/examples/reference/TableRow_setInt/.property.yml deleted file mode 100644 index ef09d79..0000000 --- a/examples/reference/TableRow_setInt/.property.yml +++ /dev/null @@ -1,22 +0,0 @@ -category: TableRow -subcategory: Method -description: " -Stores an integer value in the TableRow's specified column. The column may be specified by either its ID or title. -" -syntax: ".setInt(row, column, value)\n.setInt(row, columnName, value)" -parameters: - - label: 'row' - description: "int: ID number of the target row" - - label: 'column' - description: "int: ID number of the target column" - - label: 'value' - description: "int: value to assign" - - label: 'columnName' - description: "String: title of the target column" -related: - - XML_setFloat - - XML_setString - - XML_getInt - - XML_getFloat - - XML_getString - - Table_getStringColumn diff --git a/examples/reference/TableRow_setString/.property.yml b/examples/reference/TableRow_setString/.property.yml deleted file mode 100644 index 722a478..0000000 --- a/examples/reference/TableRow_setString/.property.yml +++ /dev/null @@ -1,20 +0,0 @@ -category: TableRow -subcategory: Method -description: " -Stores a string value in the TableRow's specified column. The column may be specified by either its ID or title. -" -syntax: ".setString(column, value)\n.setString(columnName, value)" -parameters: - - label: 'column' - description: "int: ID number of the target column" - - label: 'value' - description: "String: value to assign" - - label: 'columnName' - description: "String: title of the target column" -related: - - XML_setInt - - XML_setFloat - - XML_getInt - - XML_getFloat - - XML_getString - - Table_getStringColumn diff --git a/examples/reference/Table_addColumn/.property.yml b/examples/reference/Table_addColumn/.property.yml deleted file mode 100644 index 1612569..0000000 --- a/examples/reference/Table_addColumn/.property.yml +++ /dev/null @@ -1,13 +0,0 @@ -category: Table -subcategory: Method -description: " -Use addColumn() to add a new column to a Table object. Typically, you will want to specify a title, so the column may be easily referenced later by name. (If no title is specified, the new column's title will be null.) A column type may also be specified, in which case all values stored in this column must be of the same type (e.g., Table.INT or Table.FLOAT). If no type is specified, the default type of STRING is used. -" -syntax: ".addColumn()\n.addColumn(title)\n.addColumn(title, type)" -parameters: - - label: 'title' - description: "String: the title to be used for the new column" - - label: 'type' - description: "int: the type to be used for the new column: INT, LONG, FLOAT, DOUBLE, STRING, or CATEGORY" -related: - - Table_removeColumn diff --git a/examples/reference/Table_addRow/.property.yml b/examples/reference/Table_addRow/.property.yml deleted file mode 100644 index e24ed3d..0000000 --- a/examples/reference/Table_addRow/.property.yml +++ /dev/null @@ -1,12 +0,0 @@ -category: Table -subcategory: Method -description: " -Use addRow() to add a new row of data to a Table object. By default, an empty row is created. Typically, you would store a reference to the new row in a TableRow object (see newRow in the example above), and then set individual values using setInt(), setFloat(), or setString(). If a TableRow object is included as a parameter, then that row is duplicated and added to the table. -" -syntax: ".addRow()\n.addRow(source)" -parameters: - - label: 'source' - description: "TableRow: a reference to the original row to be duplicated" -related: - - Table_removeRow - - Table_clearRows diff --git a/examples/reference/Table_clearRows/.property.yml b/examples/reference/Table_clearRows/.property.yml deleted file mode 100644 index b15aec4..0000000 --- a/examples/reference/Table_clearRows/.property.yml +++ /dev/null @@ -1,9 +0,0 @@ -category: Table -subcategory: Method -description: " -Removes all rows from a Table. While all rows are removed, columns and column titles are maintained. -" -syntax: ".clearRows()" -related: - - Table_addRow - - Table_removeRow diff --git a/examples/reference/Table_findRow/.property.yml b/examples/reference/Table_findRow/.property.yml deleted file mode 100644 index 146188d..0000000 --- a/examples/reference/Table_findRow/.property.yml +++ /dev/null @@ -1,19 +0,0 @@ -category: Table -subcategory: Method -description: " -Finds the first row in the Table that contains the value provided, and returns a reference to that row. Even if multiple rows are possible matches, only the first matching row is returned. The column to search may be specified by either its ID or title. -" -syntax: ".findRow(value, column)\n.findRow(value, columnName)" -parameters: - - label: 'value' - description: "String: the value to match" - - label: 'column' - description: "int: ID number of the column to search" - - label: 'columnName' - description: "String: title of the column to search" -related: - - Table_getRow - - Table_rows - - Table_findRows - - Table_matchRow - - Table_matchRows diff --git a/examples/reference/Table_findRows/.property.yml b/examples/reference/Table_findRows/.property.yml deleted file mode 100644 index f902c4c..0000000 --- a/examples/reference/Table_findRows/.property.yml +++ /dev/null @@ -1,19 +0,0 @@ -category: Table -subcategory: Method -description: " -Finds the rows in the Table that contain the value provided, and returns references to those rows. Returns an iterator, so for must be used to iterate through all the rows, as shown in the example above. The column to search may be specified by either its ID or title. -" -syntax: ".findRows(value, column)\n.findRows(value, columnName)" -parameters: - - label: 'value' - description: "String: the value to match" - - label: 'column' - description: "int: ID number of the column to search" - - label: 'columnName' - description: "String: title of the column to search" -related: - - Table_getRow - - Table_rows - - Table_findRow - - Table_matchRow - - Table_matchRows diff --git a/examples/reference/Table_getColumnCount/.property.yml b/examples/reference/Table_getColumnCount/.property.yml deleted file mode 100644 index 09ca965..0000000 --- a/examples/reference/Table_getColumnCount/.property.yml +++ /dev/null @@ -1,8 +0,0 @@ -category: Table -subcategory: Method -description: " -Returns the total number of columns in a table. -" -syntax: "getColumnCount(" -related: - - Table_getRowCount diff --git a/examples/reference/Table_getFloat/.property.yml b/examples/reference/Table_getFloat/.property.yml deleted file mode 100644 index e063bf8..0000000 --- a/examples/reference/Table_getFloat/.property.yml +++ /dev/null @@ -1,20 +0,0 @@ -category: Table -subcategory: Method -description: " -Retrieves a float value from the Table's specified row and column. The row is specified by its ID, while the column may be specified by either its ID or title. -" -syntax: ".getFloat(row, column)\n.getFloat(row, columnName)" -parameters: - - label: 'row' - description: "int: ID number of the row to reference" - - label: 'column' - description: "int: ID number of the column to reference" - - label: 'columnName' - description: "String: title of the column to reference" -related: - - XML_getInt - - XML_getString - - Table_getStringColumn - - XML_setInt - - XML_setFloat - - XML_setString diff --git a/examples/reference/Table_getInt/.property.yml b/examples/reference/Table_getInt/.property.yml deleted file mode 100644 index 1408199..0000000 --- a/examples/reference/Table_getInt/.property.yml +++ /dev/null @@ -1,20 +0,0 @@ -category: Table -subcategory: Method -description: " -Retrieves an integer value from the Table's specified row and column. The row is specified by its ID, while the column may be specified by either its ID or title. -" -syntax: ".getInt(row, column)\n.getInt(row, columnName)" -parameters: - - label: 'row' - description: "int: ID number of the row to reference" - - label: 'column' - description: "int: ID number of the column to reference" - - label: 'columnName' - description: "String: title of the column to reference" -related: - - XML_getFloat - - XML_getString - - Table_getStringColumn - - XML_setInt - - XML_setFloat - - XML_setString diff --git a/examples/reference/Table_getRow/.property.yml b/examples/reference/Table_getRow/.property.yml deleted file mode 100644 index 486ce44..0000000 --- a/examples/reference/Table_getRow/.property.yml +++ /dev/null @@ -1,12 +0,0 @@ -category: Table -subcategory: Method -description: " -Returns a reference to the specified TableRow. The reference can then be used to get and set values of the selected row, as illustrated in the example above. -" -syntax: ".getRow(row)" -related: - - Table_rows - - Table_findRow - - Table_findRows - - Table_matchRow - - Table_matchRows diff --git a/examples/reference/Table_getRowCount/.property.yml b/examples/reference/Table_getRowCount/.property.yml deleted file mode 100644 index 3694ec3..0000000 --- a/examples/reference/Table_getRowCount/.property.yml +++ /dev/null @@ -1,8 +0,0 @@ -category: Table -subcategory: Method -description: " -Returns the total number of rows in a table. -" -syntax: ".getRowCount()" -related: - - Table_getColumnCount diff --git a/examples/reference/Table_getString/.property.yml b/examples/reference/Table_getString/.property.yml deleted file mode 100644 index 84c7326..0000000 --- a/examples/reference/Table_getString/.property.yml +++ /dev/null @@ -1,20 +0,0 @@ -category: Table -subcategory: Method -description: " -Retrieves a String value from the Table's specified row and column. The row is specified by its ID, while the column may be specified by either its ID or title. -" -syntax: ".getString(row, column)\n.getString(row, columnName)" -parameters: - - label: 'row' - description: "int: ID number of the row to reference" - - label: 'column' - description: "int: ID number of the column to reference" - - label: 'columnName' - description: "String: title of the column to reference" -related: - - XML_getInt - - XML_getFloat - - Table_getStringColumn - - XML_setInt - - XML_setFloat - - XML_setString diff --git a/examples/reference/Table_getStringColumn/.property.yml b/examples/reference/Table_getStringColumn/.property.yml deleted file mode 100644 index 7e96bf5..0000000 --- a/examples/reference/Table_getStringColumn/.property.yml +++ /dev/null @@ -1,18 +0,0 @@ -category: Table -subcategory: Method -description: " -Retrieves all values in the specified column, and returns them as a string list. The column may be specified by either its ID or title. -" -syntax: ".getStringColumn(columnName)\n.getStringColumn(column)" -parameters: - - label: 'columnName' - description: "String: title of the column to search" - - label: 'column' - description: "int: ID number of the column to search" -related: - - XML_getInt - - XML_getFloat - - XML_getString - - XML_setInt - - XML_setFloat - - XML_setString diff --git a/examples/reference/Table_matchRow/.property.yml b/examples/reference/Table_matchRow/.property.yml deleted file mode 100644 index bc0d0d8..0000000 --- a/examples/reference/Table_matchRow/.property.yml +++ /dev/null @@ -1,19 +0,0 @@ -category: Table -subcategory: Method -description: " -Finds the first row in the Table that matches the regular expression provided, and returns a reference to that row. Even if multiple rows are possible matches, only the first matching row is returned. The column to search may be specified by either its ID or title. -" -syntax: ".matchRow(regexp, column)\n.matchRow(regexp, columnName)" -parameters: - - label: 'regexp' - description: "String: the regular expression to match" - - label: 'column' - description: "int: ID number of the column to search" - - label: 'columnName' - description: "String: title of the column to search" -related: - - Table_getRow - - Table_rows - - Table_findRow - - Table_findRows - - Table_matchRows diff --git a/examples/reference/Table_matchRows/.property.yml b/examples/reference/Table_matchRows/.property.yml deleted file mode 100644 index 9ef500a..0000000 --- a/examples/reference/Table_matchRows/.property.yml +++ /dev/null @@ -1,19 +0,0 @@ -category: Table -subcategory: Method -description: " -Finds the rows in the Table that match the regular expression provided, and returns references to those rows. Returns an iterator, so for must be used to iterate through all the rows, as shown in the example above. The column to search may be specified by either its ID or title. -" -syntax: ".matchRows(regexp, column)\n.matchRows(regexp, columnName)" -parameters: - - label: 'regexp' - description: "String: the regular expression to match" - - label: 'column' - description: "int: ID number of the column to search" - - label: 'columnName' - description: "String: title of the column to search" -related: - - Table_getRow - - Table_rows - - Table_findRow - - Table_findRows - - Table_matchRow diff --git a/examples/reference/Table_removeColumn/.property.yml b/examples/reference/Table_removeColumn/.property.yml deleted file mode 100644 index a773392..0000000 --- a/examples/reference/Table_removeColumn/.property.yml +++ /dev/null @@ -1,13 +0,0 @@ -category: Table -subcategory: Method -description: " -Use removeColumn() to remove an existing column from a Table object. The column to be removed may be identified by either its title (a String) or its index value (an int). removeColumn(0) would remove the first column, removeColumn(1) would remove the second column, and so on. -" -syntax: ".removeColumn(columnName)\n.removeColumn(column)" -parameters: - - label: 'columnName' - description: "String: the title of the column to be removed" - - label: 'column' - description: "int: the index number of the column to be removed" -related: - - Table_addColumn diff --git a/examples/reference/Table_removeRow/.property.yml b/examples/reference/Table_removeRow/.property.yml deleted file mode 100644 index aeceacf..0000000 --- a/examples/reference/Table_removeRow/.property.yml +++ /dev/null @@ -1,12 +0,0 @@ -category: Table -subcategory: Method -description: " -Removes a row from a Table object. -" -syntax: ".removeRow(row)" -parameters: - - label: 'row' - description: "int: ID number of the row to remove" -related: - - Table_addRow - - Table_clearRows diff --git a/examples/reference/Table_removeTokens/.property.yml b/examples/reference/Table_removeTokens/.property.yml deleted file mode 100644 index cafddba..0000000 --- a/examples/reference/Table_removeTokens/.property.yml +++ /dev/null @@ -1,15 +0,0 @@ -category: Table -subcategory: Method -description: " -Removes any of the specified characters (or \"tokens\"). The example above removes all commas, dollar signs, and spaces from the table.
-
-If no column is specified, then the values in all columns and rows are processed. A specific column may be referenced by either its ID or title. -" -syntax: ".removeTokens(tokens)\n.removeTokens(tokens, column)\n.removeTokens(tokens, columnName)" -parameters: - - label: 'tokens' - description: "String: a list of individual characters to be removed" - - label: 'column' - description: "int: ID number of the column to process" - - label: 'columnName' - description: "String: title of the column to process" diff --git a/examples/reference/Table_rows/.property.yml b/examples/reference/Table_rows/.property.yml deleted file mode 100644 index 26faf46..0000000 --- a/examples/reference/Table_rows/.property.yml +++ /dev/null @@ -1,12 +0,0 @@ -category: Table -subcategory: Method -description: " -Gets all rows from the table. Returns an iterator, so for must be used to iterate through all the rows, as shown in the example above. -" -syntax: ".rows()" -related: - - Table_getRow - - Table_findRow - - Table_findRows - - Table_matchRow - - Table_matchRows diff --git a/examples/reference/Table_setFloat/.property.yml b/examples/reference/Table_setFloat/.property.yml deleted file mode 100644 index 479ab26..0000000 --- a/examples/reference/Table_setFloat/.property.yml +++ /dev/null @@ -1,22 +0,0 @@ -category: Table -subcategory: Method -description: " -Stores a float value in the Table's specified row and column. The row is specified by its ID, while the column may be specified by either its ID or title. -" -syntax: ".setFloat(row, column, value)\n.setFloat(row, columnName, value)" -parameters: - - label: 'row' - description: "int: ID number of the target row" - - label: 'column' - description: "int: ID number of the target column" - - label: 'value' - description: "float: value to assign" - - label: 'columnName' - description: "String: title of the target column" -related: - - XML_setInt - - XML_setString - - XML_getInt - - XML_getFloat - - XML_getString - - Table_getStringColumn diff --git a/examples/reference/Table_setInt/.property.yml b/examples/reference/Table_setInt/.property.yml deleted file mode 100644 index 3892721..0000000 --- a/examples/reference/Table_setInt/.property.yml +++ /dev/null @@ -1,22 +0,0 @@ -category: Table -subcategory: Method -description: " -Stores an integer value in the Table's specified row and column. The row is specified by its ID, while the column may be specified by either its ID or title. -" -syntax: ".setInt(row, column, value)\n.setInt(row, columnName, value)" -parameters: - - label: 'row' - description: "int: ID number of the target row" - - label: 'column' - description: "int: ID number of the target column" - - label: 'value' - description: "int: value to assign" - - label: 'columnName' - description: "String: title of the target column" -related: - - XML_setFloat - - XML_setString - - XML_getInt - - XML_getFloat - - XML_getString - - Table_getStringColumn diff --git a/examples/reference/Table_setString/.property.yml b/examples/reference/Table_setString/.property.yml deleted file mode 100644 index e461052..0000000 --- a/examples/reference/Table_setString/.property.yml +++ /dev/null @@ -1,22 +0,0 @@ -category: Table -subcategory: Method -description: " -Stores a String value in the Table's specified row and column. The row is specified by its ID, while the column may be specified by either its ID or title. -" -syntax: ".setString(row, column, value)\n.setString(row, columnName, value)" -parameters: - - label: 'row' - description: "int: ID number of the target row" - - label: 'column' - description: "int: ID number of the target column" - - label: 'value' - description: "String: value to assign" - - label: 'columnName' - description: "String: title of the target column" -related: - - XML_setInt - - XML_setFloat - - XML_getInt - - XML_getFloat - - XML_getString - - Table_getStringColumn diff --git a/examples/reference/Table_trim/.property.yml b/examples/reference/Table_trim/.property.yml deleted file mode 100644 index 9f80319..0000000 --- a/examples/reference/Table_trim/.property.yml +++ /dev/null @@ -1,13 +0,0 @@ -category: Table -subcategory: Method -description: " -Trims leading and trailing whitespace, such as spaces and tabs, from string table values. If no column is specified, then the values in all columns and rows are trimmed. A specific column may be referenced by either its ID or title. -" -syntax: ".trim()\n.trim(column)\n.trim(columnName)" -parameters: - - label: 'column' - description: "int: ID number of the column to trim" - - label: 'columnName' - description: "String: title of the column to trim" -related: - - Table_removeTokens diff --git a/examples/reference/XML/.property.yml b/examples/reference/XML/.property.yml deleted file mode 100644 index 20a31ba..0000000 --- a/examples/reference/XML/.property.yml +++ /dev/null @@ -1,12 +0,0 @@ -category: Data -subcategory: Composite -description: " -XML is a representation of an XML object, able to parse XML code. Use loadXML() to load external XML files and create XML objects.
-
-Only files encoded as UTF-8 (or plain ASCII) are parsed properly; the encoding parameter inside XML files is ignored. -" -syntax: "" -related: - - loadXML - - parseXML - - saveXML diff --git a/examples/reference/XML_addChild/.property.yml b/examples/reference/XML_addChild/.property.yml deleted file mode 100644 index 13447b4..0000000 --- a/examples/reference/XML_addChild/.property.yml +++ /dev/null @@ -1,8 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Appends a new child to the element. The child can be specified with either a String, which will be used as the new tag's name, or as a reference to an existing XML object.
-
-A reference to the newly created child is returned as an XML object. -" -syntax: ".addChild(tag)\n.addChild(child)\n" diff --git a/examples/reference/XML_format/.property.yml b/examples/reference/XML_format/.property.yml deleted file mode 100644 index ea25f0f..0000000 --- a/examples/reference/XML_format/.property.yml +++ /dev/null @@ -1,15 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Takes an XML object and converts it to a String, formatting its content as specified with the indent parameter.
-
-If indent is set to -1, then the String is returned with no line breaks, no indentation, and no XML declaration.
-
-If indent is set to 0 or greater, then the String is returned with line breaks, and the specified number of spaces as indent values. Meaning, there will be no indentation if 0 is specified, or each indent will be replaced with the corresponding number of spaces: 1, 2, 3, and so on. -" -syntax: ".format(indent)" -parameters: - - label: 'indent' - description: "int: -1 for a single line (and no declaration), >= 0 for indents and newlines" -related: - - XML_toString diff --git a/examples/reference/XML_getAttributeCount/.property.yml b/examples/reference/XML_getAttributeCount/.property.yml deleted file mode 100644 index 75e33a9..0000000 --- a/examples/reference/XML_getAttributeCount/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Counts the specified element's number of attributes, returned as an int. -" -syntax: ".getAttributeCount()\n" diff --git a/examples/reference/XML_getChild/.property.yml b/examples/reference/XML_getChild/.property.yml deleted file mode 100644 index 6a81a53..0000000 --- a/examples/reference/XML_getChild/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns the first of the element's children that matches the name parameter. The name or path is a series of elements and sub-elements, separated by slashes. -" -syntax: ".getChild(index)\n.getChild(name)\n" diff --git a/examples/reference/XML_getChildren/.property.yml b/examples/reference/XML_getChildren/.property.yml deleted file mode 100644 index 8b7d05b..0000000 --- a/examples/reference/XML_getChildren/.property.yml +++ /dev/null @@ -1,9 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns all of the element's children as an array of XML objects. When the name parameter is specified, then it will return all children that match that name or path. The path is a series of elements and sub-elements, separated by slashes. -" -syntax: ".getChildren()\n.getChildren(name)" -parameters: - - label: 'name' - description: "String: element name or path/to/element" diff --git a/examples/reference/XML_getContent/.property.yml b/examples/reference/XML_getContent/.property.yml deleted file mode 100644 index 9865ff8..0000000 --- a/examples/reference/XML_getContent/.property.yml +++ /dev/null @@ -1,9 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns the content of an element. If there is no such content, null is returned. -" -syntax: ".getContent()\n.getContent(defaultValue)" -related: - - XML_getIntContent - - XML_getFloatContent diff --git a/examples/reference/XML_getFloat/.property.yml b/examples/reference/XML_getFloat/.property.yml deleted file mode 100644 index 5338549..0000000 --- a/examples/reference/XML_getFloat/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns an attribute value of the element as a float. If the defaultValue parameter is specified and the attribute doesn't exist, then defaultValue is returned. If no defaultValue is specified and the attribute doesn't exist, the value 0.0 is returned. -" -syntax: ".getFloat(name)\n.getFloat(name, defaultValue)\n" diff --git a/examples/reference/XML_getFloatContent/.property.yml b/examples/reference/XML_getFloatContent/.property.yml deleted file mode 100644 index 9aa7a50..0000000 --- a/examples/reference/XML_getFloatContent/.property.yml +++ /dev/null @@ -1,9 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns the content of an element as a float. If there is no such content, either null or the provided default value is returned. -" -syntax: ".getFloatContent()\n.getFloatContent(defaultValue)" -related: - - XML_getContent - - XML_getIntContent diff --git a/examples/reference/XML_getInt/.property.yml b/examples/reference/XML_getInt/.property.yml deleted file mode 100644 index 09bcb62..0000000 --- a/examples/reference/XML_getInt/.property.yml +++ /dev/null @@ -1,11 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns an attribute value of the element as an int. If the defaultValue parameter is specified and the attribute doesn't exist, then defaultValue is returned. If no defaultValue is specified and the attribute doesn't exist, the value 0 is returned. -" -syntax: ".getInt(name)\n.getInt(name, defaultValue)" -parameters: - - label: 'name' - description: "String: the non-null full name of the attribute" - - label: 'defaultValue' - description: "int: the default value of the attribute" diff --git a/examples/reference/XML_getIntContent/.property.yml b/examples/reference/XML_getIntContent/.property.yml deleted file mode 100644 index 2d72180..0000000 --- a/examples/reference/XML_getIntContent/.property.yml +++ /dev/null @@ -1,12 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns the content of an element as an int. If there is no such content, either null or the provided default value is returned. -" -syntax: ".getIntContent()\n.getIntContent(defaultValue)" -parameters: - - label: 'defaultValue' - description: "int: the default value of the attribute" -related: - - XML_getContent - - XML_getFloatContent diff --git a/examples/reference/XML_getName/.property.yml b/examples/reference/XML_getName/.property.yml deleted file mode 100644 index e334673..0000000 --- a/examples/reference/XML_getName/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Gets the element's full name, which is returned as a String. -" -syntax: ".getName()\n" diff --git a/examples/reference/XML_getParent/.property.yml b/examples/reference/XML_getParent/.property.yml deleted file mode 100644 index c9233b3..0000000 --- a/examples/reference/XML_getParent/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Gets a copy of the element's parent. Returns the parent as another XML object. -" -syntax: ".getParent()\n" diff --git a/examples/reference/XML_getString/.property.yml b/examples/reference/XML_getString/.property.yml deleted file mode 100644 index f401c65..0000000 --- a/examples/reference/XML_getString/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Returns an attribute value of the element as a String. If the defaultValue parameter is specified and the attribute doesn't exist, then defaultValue is returned. If no defaultValue is specified and the attribute doesn't exist, null is returned. -" -syntax: ".getString(name)\n.getString(name, defaultValue)\n" diff --git a/examples/reference/XML_hasAttribute/.property.yml b/examples/reference/XML_hasAttribute/.property.yml deleted file mode 100644 index 79dbe94..0000000 --- a/examples/reference/XML_hasAttribute/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Checks whether or not an element has the specified attribute. The attribute must be specified as a String, and a Boolean is returned. -" -syntax: ".hasAttribute(name)\n" diff --git a/examples/reference/XML_hasChildren/.property.yml b/examples/reference/XML_hasChildren/.property.yml deleted file mode 100644 index 6e74c19..0000000 --- a/examples/reference/XML_hasChildren/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Checks whether or not the element has any children, and returns the result as a Boolean. -" -syntax: ".hasChildren()\n" diff --git a/examples/reference/XML_listAttributes/.property.yml b/examples/reference/XML_listAttributes/.property.yml deleted file mode 100644 index 89a8a29..0000000 --- a/examples/reference/XML_listAttributes/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Gets all of the specified element's attributes, and returns them as a list of Strings. -" -syntax: ".listAttributes()\n" diff --git a/examples/reference/XML_listChildren/.property.yml b/examples/reference/XML_listChildren/.property.yml deleted file mode 100644 index 9a78452..0000000 --- a/examples/reference/XML_listChildren/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Get the names of all of the element's children, and returns the names as an list of Strings. This is the same as looping through and calling getName() on each child element individually. -" -syntax: ".listChildren()\n" diff --git a/examples/reference/XML_removeChild/.property.yml b/examples/reference/XML_removeChild/.property.yml deleted file mode 100644 index 6ab998c..0000000 --- a/examples/reference/XML_removeChild/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Removes the specified element. First use getChild() to get a reference to the desired element. Then pass that reference to removeChild() to delete it. -" -syntax: ".removeChild(kid)\n" diff --git a/examples/reference/XML_setContent/.property.yml b/examples/reference/XML_setContent/.property.yml deleted file mode 100644 index ff43f31..0000000 --- a/examples/reference/XML_setContent/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Sets the element's content, which is specified as a String. -" -syntax: ".setContent(text)\n" diff --git a/examples/reference/XML_setFloat/.property.yml b/examples/reference/XML_setFloat/.property.yml deleted file mode 100644 index 7f8d924..0000000 --- a/examples/reference/XML_setFloat/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Sets the content of an element's attribute as a float. A String specifies the attribute name, while the float specifies the new content. -" -syntax: ".setFloat(name, value)\n" diff --git a/examples/reference/XML_setInt/.property.yml b/examples/reference/XML_setInt/.property.yml deleted file mode 100644 index 886c76e..0000000 --- a/examples/reference/XML_setInt/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Sets the content of an element's attribute as an int. A String specifies the attribute name, while the int specifies the new content. -" -syntax: ".setInt(name, value)\n" diff --git a/examples/reference/XML_setName/.property.yml b/examples/reference/XML_setName/.property.yml deleted file mode 100644 index a9dc4d5..0000000 --- a/examples/reference/XML_setName/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Sets the element's name, which is specified as a String. -" -syntax: ".setName(newName)\n" diff --git a/examples/reference/XML_setString/.property.yml b/examples/reference/XML_setString/.property.yml deleted file mode 100644 index 1b3c76b..0000000 --- a/examples/reference/XML_setString/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Sets the content of an element's attribute as a String. The first String specifies the attribute name, while the second specifies the new content. -" -syntax: ".setString(name, value)\n" diff --git a/examples/reference/XML_toString/.property.yml b/examples/reference/XML_toString/.property.yml deleted file mode 100644 index b73083a..0000000 --- a/examples/reference/XML_toString/.property.yml +++ /dev/null @@ -1,8 +0,0 @@ -category: XMLElement -subcategory: Method -description: " -Takes an XML object and converts it to a String, using default formatting rules (includes an XML declaration, line breaks, and two spaces for indents). These are the same formatting rules used by print() when printing an XML object. This method produces the same results as using format(2). -" -syntax: ".toString()" -related: - - XML_format diff --git a/examples/reference/class/.property.yml b/examples/reference/class/.property.yml deleted file mode 100644 index 3490d0e..0000000 --- a/examples/reference/class/.property.yml +++ /dev/null @@ -1,13 +0,0 @@ -category: Structure -subcategory: -description: " -Keyword used to indicate the declaration of a class. A class is a composite of fields (data) and methods (functions that are a part of the class) which may be instantiated as objects. The first letter of a class name is usually uppercase to separate it from other kinds of variables. In Python, instance variables are accessed via the self keyword. -" -syntax: "class ClassName(object):\n statements\nif and else structure. Conditional expressions in Python take the form expression1 if test else expression2. If the test evaluates to True, expression1 is evaluated and returned. If the condition evaluates to False, expression2 is evaluated and returned. -

-The following conditional expression:
-
result = expression1 if test else expression2

-is equivalent to this structure:
-
if test:
- result = expression1
- else:
- result = expression2
-
-" -syntax: "expression1 if test else expression2" -parameters: - - label: 'test' - description: "any valid expression which evaluates to True or False" - - label: 'expression1' - description: "any valid expression" - - label: 'expression2' - description: "any valid expression" -related: - - if - - else diff --git a/examples/reference/dict_items/.property.yml b/examples/reference/dict_items/.property.yml deleted file mode 100644 index 57f65fa..0000000 --- a/examples/reference/dict_items/.property.yml +++ /dev/null @@ -1,18 +0,0 @@ -category: Data -subcategory: Dictionary Methods -description: " -Returns the key/value pairs present in the dictionary, in the form of a -list of tuples. For large dictionaries, consider using -iteritems() instead, which returns -an iterator.

- -Note that because of the nature of the dictionary data structure, key/value -pairs returned from items() will be in arbitrary order (not necessarily -the order they appeared in when the dictionary was defined). -" -syntax: " dict.items()" -parameters: - - label: 'dict' - description: "The dictionary whose items will be returned." -related: - - dictionary diff --git a/examples/reference/dict_iteritems/.property.yml b/examples/reference/dict_iteritems/.property.yml deleted file mode 100644 index 8c320f0..0000000 --- a/examples/reference/dict_iteritems/.property.yml +++ /dev/null @@ -1,23 +0,0 @@ -category: Data -subcategory: Dictionary Methods -description: " -Returns tuples of the key/value pairs present in the specified dictionary, in -the form of an iterator. This iterator is primarily useful as a means of -iterating over every key/value pair in a dictionary in a for loop, as -shown in the example above.

- -The iteritems() method is more memory-efficient than the items() -method, as it returns each item in succession, instead of reproducing the -entire dictionary as a list in memory.

- -Note that because of the nature of the dictionary data structure, key/value -pairs returned from iteritems() will be in arbitrary order (not -necessarily the order they appeared in when the dictionary was defined). -" -syntax: " dict.iteritems()" -parameters: - - label: 'dict' - description: "The dictionary to be iterated over." -related: - - dictionary - - dict_items diff --git a/examples/reference/dict_keys/.property.yml b/examples/reference/dict_keys/.property.yml deleted file mode 100644 index b465fb1..0000000 --- a/examples/reference/dict_keys/.property.yml +++ /dev/null @@ -1,11 +0,0 @@ -category: Data -subcategory: Dictionary Methods -description: " -Returns a list of keys in the given dictionary. -" -syntax: " dict.keys()" -parameters: - - label: 'dict' - description: "The dictionary whose keys will be returned." -related: - - dictionary diff --git a/examples/reference/dict_update/.property.yml b/examples/reference/dict_update/.property.yml deleted file mode 100644 index afdc932..0000000 --- a/examples/reference/dict_update/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: Dictionary Methods -description: " -\"Updates\" a dictionary with the contents of a second dictionary. Any key/value -pairs present in the second dictionary will be added to the first. If the -second dictionary contains a key present in the first dictionary, its value -will be overwritten with the value from the second dictionary. -" -syntax: " dict1.update(dict2)" -parameters: - - label: 'dict1' - description: "The dictionary to be updated." - - label: 'dict2' - description: "The source dictionary for the update, where new key/value pairs will be drawn from." -related: - - dictionary diff --git a/examples/reference/dict_values/.property.yml b/examples/reference/dict_values/.property.yml deleted file mode 100644 index 62d83aa..0000000 --- a/examples/reference/dict_values/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: Dictionary Methods -description: " -Returns a list of all values in the dictionary (without reference to their -keys).

- -Note that because of the nature of the dictionary data structure, -the return value of values() will be in arbitrary order. -" -syntax: " dict.values()" -parameters: - - label: 'dict' - description: "The dictionary whose values will be returned." -related: - - dictionary - - dict_keys diff --git a/examples/reference/dictionary/.property.yml b/examples/reference/dictionary/.property.yml deleted file mode 100644 index c3a3649..0000000 --- a/examples/reference/dictionary/.property.yml +++ /dev/null @@ -1,32 +0,0 @@ -category: Data -subcategory: Composite -description: " -A dictionary is a Python data structure that stores a number of values, -referenced by key. It's similar to a list, except values are accessed by keys -of arbitrary types (usually strings), instead of with sequential integer -indexes. Python's dictionary type is similar to \"Maps\" in Java, associative -arrays in PHP, or hashes in Perl.

- -In Python, dictionary values can be of any type (and types can vary from one -key/value pair to the next in the same dictionary). Keys can be of any type, as -long as that type is \"hashable\" (see the Python -glossary for more information).

- -Note that while Python remembers all key/value pairs added to a dictionary, it -does not remember the order in which key/value pairs were added. As a -consequence, when iterating over key/value pairs in a dictionary (with, e.g., -the iteritems() method shown in the example above), the key/value pairs -will come back in an arbitrary order, which may vary from one execution of your -program to the next.

- -" -syntax: "d = {}\nd = dict()\nd = {key: value, key2: value}" -parameters: - - label: 'key' - description: "any immutable object; used to index the dictionary (ex. String or int)" - - label: 'value' - description: "any value to be stored in the dictionary" -related: - - curlybraces - - indexbrackets diff --git a/examples/reference/float/.property.yml b/examples/reference/float/.property.yml deleted file mode 100644 index a9463ce..0000000 --- a/examples/reference/float/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: Primitive -description: " -Data type for floating-point numbers, a number that has a decimal point. -
-Floats are not precise, so avoid adding small values (such as 0.0001), as these may not always increment because of rounding error. If you want to increment a value in small intervals, use an int, and divide by a float value before using it. (See above example.)
-
-" -syntax: "var = value" -parameters: - - label: 'var' - description: "variable name referencing the float" - - label: 'value' - description: "any floating-point value" -related: - - int diff --git a/examples/reference/for/.property.yml b/examples/reference/for/.property.yml deleted file mode 100644 index 99db301..0000000 --- a/examples/reference/for/.property.yml +++ /dev/null @@ -1,24 +0,0 @@ -category: Control -subcategory: Iteration -description: " -Controls a sequence of repetitions. In Python, a for loop requires a list function to iterate over. The range() function provides such a list, and accepts arguments in three ways:
-
-range(10) # Creates the list [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
-range(5, 10) # Creates the list [5, 6, 7, 8, 9]
-range(5, 10, 2) # Creates the list [5, 7, 9]
-
-
-In the first example above, the for structure is executed 40 times. The for structure loops until it reaches the last element of the list created by range(40): 39.
-
-A second type of for structure makes it easier to iterate over each element of a list. The last example above shows how it works. First, define a variable name. This variable name will be assigned to each element of the list in turn as the for moves through the entire list. Then specify the list to iterate over after in, in this case nums. -" -syntax: "for var in iterable:\n statements\n\nfor var in iterable:\n statements" -parameters: - - label: 'var' - description: "variable to be assigned to each element of the iterable" - - label: 'iterable' - description: "iterable object to loop over" - - label: 'statements' - description: "collection of statements executed each time through the loop" -related: - - while diff --git a/examples/reference/globals/.property.yml b/examples/reference/globals/.property.yml deleted file mode 100644 index f55fc98..0000000 --- a/examples/reference/globals/.property.yml +++ /dev/null @@ -1,6 +0,0 @@ -category: Structure -subcategory: -description: " -Global variables are declared outside functions and are readable throughout the program. If you wish to modify or create a global variable from within a function, you must use the global Python statement. -" -syntax: " x = 0\n\n def foo():\n global x\n x = 5 \n" diff --git a/examples/reference/indexbrackets/.property.yml b/examples/reference/indexbrackets/.property.yml deleted file mode 100644 index 8157ade..0000000 --- a/examples/reference/indexbrackets/.property.yml +++ /dev/null @@ -1,49 +0,0 @@ -category: Structure -subcategory: -description: " - -Index brackets ([]) have many uses in Python. First, they are used to -define \"list literals,\" allowing you to declare a list and its contents in your -program. Index brackets are also used to write expressions that evaluate to a -single item within a list, or a single character in a string.

- -For lists and other mutable sequences (but not strings), you can overwrite a -value at a particular index using the assignment operator (=).

- -Negative numbers inside of index brackets cause Python to start counting -from the end of the sequence, instead of from the beginning. For example, -the expression x[-1] evaluates to the last item of list x, -x[-2] evaluates to the second-to-last item of list x, and -so forth.

- -Finally, index brackets are used to retrieve or set the value for a given key -in a dictionary. For example, the expression x[a] evaluates to -whatever the value for key a is in dictionary x. The -statement x[a] = b will set the value for key a in dictionary -x to a new value b (overwriting any existing value).

- -Specifying an index beyond the bounds of the sequence raises an -IndexError exception. Attempting to retrieve the value for a -key that does not exist in a dictionary raises a KeyError exception. -

- -" -syntax: " [elem0, ..., elemN]\n sequence[index]\n sequence[index] = expr\n dict[key]\n dict[key] = value" -parameters: - - label: 'elem0, ..., elemN' - description: "list of elements, separated by commas, used to initialize a list" - - label: 'sequence' - description: "a list, string or other sequence" - - label: 'index' - description: "an integer index" - - label: 'expr' - description: "an expression, the result of which will be assigned to the given index in the sequence" - - label: 'dict' - description: "a dictionary" - - label: 'key' - description: "the key whose value you want to retrieve" - - label: 'value' - description: "a new value for the given key" -related: - - slice - - curlybraces diff --git a/examples/reference/int/.property.yml b/examples/reference/int/.property.yml deleted file mode 100644 index 08cd499..0000000 --- a/examples/reference/int/.property.yml +++ /dev/null @@ -1,13 +0,0 @@ -category: Data -subcategory: Primitive -description: " -Datatype for integers, numbers without a decimal point. Integers can be as large as 9,223,372,036,854,775,807 and as low as -9,223,372,036,854,775,808. They are stored as 32 bits of information. -" -syntax: "var = value" -parameters: - - label: 'var' - description: "variable name referencing the value" - - label: 'value' - description: "any integer value" -related: - - float diff --git a/examples/reference/list/.property.yml b/examples/reference/list/.property.yml deleted file mode 100644 index 44346db..0000000 --- a/examples/reference/list/.property.yml +++ /dev/null @@ -1,19 +0,0 @@ -category: Data -subcategory: Conversion -description: " - -Takes an \"iterable\" object as a parameter and returns a list of items in the -object. (An \"iterable\" object is an object that can be looped over, such as a -list, string, dictionary, set or tuple; more information here.) This function is useful -for converting a string to list of individual characters, for making copies -of existing lists, and for making empty lists.

- -This function is also useful for converting Python iterators (returned from, -e.g., reversed() or the dictionary object's iteritems()) and -converting them to lists. - -" -syntax: "list(x)" -parameters: - - label: 'x' - description: "iterable to convert to a list" diff --git a/examples/reference/list_append/.property.yml b/examples/reference/list_append/.property.yml deleted file mode 100644 index 9fadf3a..0000000 --- a/examples/reference/list_append/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Add an item to the end of the list. -" -syntax: "a.append(x)" -parameters: - - label: 'a' - description: "list to append to" - - label: 'x' - description: "item to append" -related: - - list_insert - - list_pop - - list_reverse - - list_index diff --git a/examples/reference/list_extend/.property.yml b/examples/reference/list_extend/.property.yml deleted file mode 100644 index 376407f..0000000 --- a/examples/reference/list_extend/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Extends a list by appending all of the elements of another list to the end. -" -syntax: "a.extend(x)" -parameters: - - label: 'a' - description: "list to extend" - - label: 'x' - description: "list of items to append to original list" -related: - - list_insert - - list_pop - - list_reverse - - list_index diff --git a/examples/reference/list_index/.property.yml b/examples/reference/list_index/.property.yml deleted file mode 100644 index 2750c4d..0000000 --- a/examples/reference/list_index/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Return the index in the list of the first item whose value is x. Raises a ValueError exception if there is no such item. -" -syntax: "a.index(x)" -parameters: - - label: 'a' - description: "the list to search through" - - label: 'x' - description: "the item to search for" -related: - - list_insert - - list_pop - - list_reverse - - list_append diff --git a/examples/reference/list_insert/.property.yml b/examples/reference/list_insert/.property.yml deleted file mode 100644 index ba9bc81..0000000 --- a/examples/reference/list_insert/.property.yml +++ /dev/null @@ -1,18 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Insert an item into a list at a given index. -" -syntax: "a.insert(i, x)" -parameters: - - label: 'a' - description: "The list to insert into." - - label: 'i' - description: "The index of the element before which to insert." - - label: 'x' - description: "The item to insert." -related: - - list_append - - list_pop - - list_reverse - - list_index diff --git a/examples/reference/list_pop/.property.yml b/examples/reference/list_pop/.property.yml deleted file mode 100644 index 6a6f191..0000000 --- a/examples/reference/list_pop/.property.yml +++ /dev/null @@ -1,17 +0,0 @@ -category: Data -subcategory: List Methods -description: " -This method removes and returns an element of the list from the given index. If -no index is given, the last element is removed and returned. -" -syntax: "a.pop()\na.pop(i)" -parameters: - - label: 'a' - description: "List from which to pop." - - label: 'i' - description: "Index of element to pop." -related: - - list_insert - - list_append - - list_reverse - - list_index diff --git a/examples/reference/list_remove/.property.yml b/examples/reference/list_remove/.property.yml deleted file mode 100644 index b7ae088..0000000 --- a/examples/reference/list_remove/.property.yml +++ /dev/null @@ -1,17 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Removes the given item from the list. Raises a ValueError exception if the -item isn't found. -" -syntax: "a.remove(i)" -parameters: - - label: 'a' - description: "List from which to remove an item." - - label: 'i' - description: "The item to remove." -related: - - list_insert - - list_append - - list_reverse - - list_index diff --git a/examples/reference/list_reverse/.property.yml b/examples/reference/list_reverse/.property.yml deleted file mode 100644 index d7b3f0f..0000000 --- a/examples/reference/list_reverse/.property.yml +++ /dev/null @@ -1,14 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Reverse the elements of a list in place. -" -syntax: " a.reverse()" -parameters: - - label: 'a' - description: "list: the list to be reversed" -related: - - list_insert - - list_pop - - list_append - - list_index diff --git a/examples/reference/list_sort/.property.yml b/examples/reference/list_sort/.property.yml deleted file mode 100644 index 0f41584..0000000 --- a/examples/reference/list_sort/.property.yml +++ /dev/null @@ -1,29 +0,0 @@ -category: Data -subcategory: List Methods -description: " -Sort the elements of a list in place. Numbers are sorted by their value, and -strings are sorted in (case-sensitive) alphabetical order. If the keyword -argument reverse is given and set to True, the list is sorted in -reverse. -

- -An optional keyword parameter key specifies a function that will be -called for each item of the list before comparing it in the sorting process. -This function takes a single parameter and should return the value that Python -should use for the specified value when sorting the list. You can use this -functionality to easily build (as in the example above) a case-insensitive -sort. - -" -syntax: "a.sort()" -parameters: - - label: 'a' - description: "the list to sort" - - label: 'fn' - description: "a function, called automatically for each list element" -related: - - list_insert - - list_pop - - list_append - - list_index - - sorted diff --git a/examples/reference/multilinecomment/.property.yml b/examples/reference/multilinecomment/.property.yml deleted file mode 100644 index b8f4df7..0000000 --- a/examples/reference/multilinecomment/.property.yml +++ /dev/null @@ -1,11 +0,0 @@ -category: Structure -subcategory: -description: " -Explanatory notes embedded within the code. Comments are used to remind yourself and to inform others about the function of your program. Multiline comments are used for large text descriptions of code or to comment out chunks of code while debugging applications. Note that in Python mode you can make multiline comments with single quotes '''like this''' or with double quotes \"\"\"like this\"\"\". Comments are ignored by the interpreter. -" -syntax: "\"\"\"\n comment\n\"\"\"\nor \n'''\n comment\n'''" -parameters: - - label: 'comment' - description: "any sequence of characters" -related: - - comment diff --git a/examples/reference/print/.property.yml b/examples/reference/print/.property.yml index 6257a61..68b6b7c 100644 --- a/examples/reference/print/.property.yml +++ b/examples/reference/print/.property.yml @@ -4,7 +4,7 @@ description: " The print() function writes to the console area, the black rectangle at the bottom of the Processing environment. This function is often helpful for looking at the data a program is producing.

Using print() on an object will output a string representation of that object, as determined by its internal __str__ and __repr__ methods (more information here).

-In Python Mode, print() and println() are functionally identical. +In R Mode, print() and println() are functionally identical. " syntax: "print(what)" parameters: diff --git a/examples/reference/println/.property.yml b/examples/reference/println/.property.yml index cec48b7..6a852cd 100644 --- a/examples/reference/println/.property.yml +++ b/examples/reference/println/.property.yml @@ -5,7 +5,7 @@ description: "
Using println() on an object will output a string representation of that object, as determined by its internal __str__ and __repr__ methods (more information here).

-In Python Mode, print() and println() are functionally identical. +In R Mode, print() and println() are functionally identical. " syntax: "println(what)" parameters: diff --git a/examples/reference/slice/.property.yml b/examples/reference/slice/.property.yml deleted file mode 100644 index f601815..0000000 --- a/examples/reference/slice/.property.yml +++ /dev/null @@ -1,35 +0,0 @@ -category: Structure -subcategory: -description: " - -Python's index bracket syntax allows you to easily write expressions that -evaluate to a section, or \"slice,\" of a list. The syntax for getting a slice -of a list looks very similar to the syntax for getting a single item, except -instead of putting a single number inside the square brackets, you put two -numbers, separated by a colon, indicating where the slice should start and -end.

- -For example, the expression x[n:m] evaluates to a list that contains -items from index n up to (but not including) index m from a -list x. If n is omitted, it's assumed to be 0, and the slice will -begin at the beginning of the list. If m is omitted, the slice will end -at the end of the list.

- -When slice indexes are negative, they follow the same rules for negative -indexes in general (see index brackets for -more information).

- -Slice syntax works with strings as well, and is a convenient way to extract -substrings by numerical index.

- -" -syntax: " sequence[begin:end]" -parameters: - - label: 'sequence' - description: "list: string or other sequence" - - label: 'begin' - description: "int: index at which to begin the slice" - - label: 'end' - description: "int: integer index at which to end the slice" -related: - - diff --git a/examples/reference/sorted/.property.yml b/examples/reference/sorted/.property.yml deleted file mode 100644 index 887ba9a..0000000 --- a/examples/reference/sorted/.property.yml +++ /dev/null @@ -1,27 +0,0 @@ -category: Data -subcategory: List Functions -description: " -Returns a sorted copy of the given list (or other iterable). Like the -sort() method of the list object, it can take an optional key -parameter to specify a function that should be evaluated for each item in the -list before sorting that item. The optional parameter reverse, if set -to True, causes sorted() to perform its sorting operation in -reverse order.

- -The sorted() function differs from a list object's sort() method -in two important ways. First, it returns a copy of the sorted list, leaving the -original list intact (instead of sorting the list in-place). Second, -sorted() works with any iterable (e.g., strings, tuples, dictionaries), -not just lists. -

- -For more information and examples, consult the Sorting Mini-HOWTO on the Python Wiki. -" -syntax: "sorted(iterable)\nsorted(iterable, reverse=True)\nsorted(iterable, key=fn)" -parameters: - - label: 'list' - description: "list to sort" - - label: 'count' - description: "int: number of elements to sort, starting from 0" -related: - - list_reverse diff --git a/examples/reference/string/.property.yml b/examples/reference/string/.property.yml deleted file mode 100644 index d4dce22..0000000 --- a/examples/reference/string/.property.yml +++ /dev/null @@ -1,38 +0,0 @@ -category: Data -subcategory: Composite -description: " -A string is a sequence of characters. Python's built-in string class includes -methods for searching strings, transforming strings, and checking to see if a -string has particular characteristics. Strings are defined inside either double -quotes (\"ABC\") or single quotes ('ABC'). -

- -Because strings are defined between quotation marks, to include such marks -within the string itself you must use the \ (backslash) character. -(See the second example above.) This is known as an escape - sequence. Other escape sequences include \t for the tab -character and \n for new line. Because backslash is the escape -character, to include a single backslash within a string, you must use two -consecutive backslashes, as in: \\ -

- -Normally, strings in your program must be written entirely on one line. If you -want to include a chunk of text in your program that spans multiple lines, you -can use triple quotes (either \"\"\" or '''). (See the third example -above.) -

- -There are more string methods than those linked from this page. Additional documentation is located online in the official Python documentation. - -" -syntax: " 'str'\n \"str\"\n \"\"\"\n str\n \"\"\"" -parameters: - - label: 'str' - description: "any string of characters" -related: - - string_formatting - - string_find - - string_strip - - string_join - - string_split - - string_replace diff --git a/examples/reference/string_find/.property.yml b/examples/reference/string_find/.property.yml deleted file mode 100644 index 915ea2f..0000000 --- a/examples/reference/string_find/.property.yml +++ /dev/null @@ -1,23 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Return the lowest index in the string where a substring is found. Optional -arguments start and end specify a range to search in. If the substring is not -found, returns -1. - -" -syntax: "a.find(sub)\na.find(sub,start,end)" -parameters: - - label: 'sub' - description: "substring to search for" - - label: 'start' - description: "starting point in search range" - - label: 'end' - description: "end point in search range" -related: - - string - - string_formatting - - string_find - - string_strip - - string_join - - string_replace diff --git a/examples/reference/string_formatting/.property.yml b/examples/reference/string_formatting/.property.yml deleted file mode 100644 index 0180e2f..0000000 --- a/examples/reference/string_formatting/.property.yml +++ /dev/null @@ -1,20 +0,0 @@ -category: Structure -subcategory: -description: " -Substitute variables in a string using the string format operator % as shown above. Symbols that can be used with % include: -%i for integers, %f for floats and %s for strings. -" -syntax: " \"%s\" % \"string\"\n \"%i\" % 10 \n \"%f\" % 10.5" -parameters: - - label: '%s' - description: "String: any string" - - label: '%i' - description: "int: any int" - - label: '%f' - description: "float: any float" -related: - - string - - string_find - - string_strip - - string_join - - string_replace diff --git a/examples/reference/string_join/.property.yml b/examples/reference/string_join/.property.yml deleted file mode 100644 index 14f0b19..0000000 --- a/examples/reference/string_join/.property.yml +++ /dev/null @@ -1,18 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Combines a sequence of strings to create a new string, separating each item from the sequence with the content of the string the method is called on. - -" -syntax: " separator.join(sequence)" -parameters: - - label: 'separator' - description: "The string to insert between elements of the sequence." - - label: 'sequence' - description: "A sequence (e.g., list or tuple) of strings to be joined together." -related: - - string_formatting - - string_find - - string_strip - - string_split - - string_replace diff --git a/examples/reference/string_lower/.property.yml b/examples/reference/string_lower/.property.yml deleted file mode 100644 index 434adf8..0000000 --- a/examples/reference/string_lower/.property.yml +++ /dev/null @@ -1,17 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Returns a copy of a string, with all uppercase characters converted to -lowercase. -" -syntax: " str.lower()" -parameters: - - label: 'str' - description: "String: any string of characters." -related: - - string - - string_formatting - - string_find - - string_strip - - string_join - - string_replace diff --git a/examples/reference/string_replace/.property.yml b/examples/reference/string_replace/.property.yml deleted file mode 100644 index 6bd5c36..0000000 --- a/examples/reference/string_replace/.property.yml +++ /dev/null @@ -1,17 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Returns a copy of the string with all occurrences of an old substring replaced by a new substring. -" -syntax: "s.replace(old, new)" -parameters: - - label: 'old' - description: "substring to replace" - - label: 'new' - description: "substring to substitute old with" -related: - - string_split - - string_join - - string_strip - - string_find - - string_formatting diff --git a/examples/reference/string_split/.property.yml b/examples/reference/string_split/.property.yml deleted file mode 100644 index fb7f2c3..0000000 --- a/examples/reference/string_split/.property.yml +++ /dev/null @@ -1,18 +0,0 @@ -category: Data -subcategory: String Methods -description: " -The method split() returns a list of all words in the string using the provided separator. An optional second argument limits the number of splits. -" -syntax: "str.split(sep)\nstr.split(sep,num)" -parameters: - - label: 'sep' - description: "string to split words by" - - label: 'num' - description: "number of elements to split" -related: - - string - - string_formatting - - string_find - - string_join - - string_split - - string_replace diff --git a/examples/reference/string_startswith/.property.yml b/examples/reference/string_startswith/.property.yml deleted file mode 100644 index 9140137..0000000 --- a/examples/reference/string_startswith/.property.yml +++ /dev/null @@ -1,17 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Returns true if the string begins with the specified substring, and false -otherwise. -" -syntax: "a.startswith(sub)" -parameters: - - label: 'sub' - description: "substring to search for" -related: - - string - - string_formatting - - string_find - - string_strip - - string_join - - string_replace diff --git a/examples/reference/string_strip/.property.yml b/examples/reference/string_strip/.property.yml deleted file mode 100644 index 8e25fca..0000000 --- a/examples/reference/string_strip/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Retruns a copy of the string with leading and trailing characters removed -- whitespace by default. Given an optional argument, strip removes specific leading and trailing characters. -" -syntax: "a.strip()\na.strip(chars)\n" -parameters: - - label: 'chars' - description: "an optional argument that removes specific characters" -related: - - string - - string_formatting - - string_find - - string_join - - string_split - - string_replace diff --git a/examples/reference/string_upper/.property.yml b/examples/reference/string_upper/.property.yml deleted file mode 100644 index e85ceae..0000000 --- a/examples/reference/string_upper/.property.yml +++ /dev/null @@ -1,18 +0,0 @@ -category: Data -subcategory: String Methods -description: " -Returns a copy of a string, with all lowercase characters converted to -uppercase. -" -syntax: " str.upper()" -parameters: - - label: 'str' - description: "String: any string of characters." -related: - - string - - string_formatting - - string_find - - string_strip - - string_join - - string_replace - - string_lower diff --git a/examples/reference/super/.property.yml b/examples/reference/super/.property.yml deleted file mode 100644 index baa0aff..0000000 --- a/examples/reference/super/.property.yml +++ /dev/null @@ -1,16 +0,0 @@ -category: Structure -subcategory: -description: " -The super() function allows you to call a method defined in a parent -class. Invoke the function with two parameters: the name of the class the -method is defined in, and self. See the -official Python documentation for more details. - -" -syntax: "super(class, self)" -parameters: - - label: 'class' - description: "The class in which the method is defined" -related: - - class diff --git a/examples/reference/tuple/.property.yml b/examples/reference/tuple/.property.yml deleted file mode 100644 index 70c3799..0000000 --- a/examples/reference/tuple/.property.yml +++ /dev/null @@ -1,33 +0,0 @@ -category: Data -subcategory: Composite -description: " -Tuples are one of Python's basic composite data types, along with lists -and dictionaries. A tuple is a lot like a list, in that it consists of a -sequence of elements that can be accessed by index. However, unlike a list, -a tuple can't be modified after it's created. (Tuples can't be assigned to -by index, nor do they have an append() method.)

- -You can convert a list to a tuple using the tuple() function, or -convert a tuple to a list using list().

- -Because tuples have a fixed size, Python can make some optimizations behind the -scenes regarding how they're stored in memory. For this reason, tuples can be -marginally faster and more efficient than lists in some applications. Because -tuples are immutable (i.e., they can't be changed after creation), they are -also \"hashable\" and can be used as keys in dictionaries.

- -When writing a tuple literal that has only one element, you need to put a -comma after that element. (Otherwise, Python will interpret the parentheses -as \"grouping\" a single expression for the purposes of controlling the order -of execution.) - -" -syntax: " var = (elem1, ..., elemN)" -parameters: - - label: 'elem' - description: "any element to store within the tuple" -related: - - list - - dictionary - - indexbrackets - - parentheses diff --git a/src/rprocessing/mode/RLangInputHandler.java b/src/rprocessing/mode/RLangInputHandler.java index 0e6fd3e..96d5587 100644 --- a/src/rprocessing/mode/RLangInputHandler.java +++ b/src/rprocessing/mode/RLangInputHandler.java @@ -146,7 +146,7 @@ public boolean handlePressed(KeyEvent event) { private class LineInfo { public final int lineNumber; - // Expressed in units of "python indents", not in number of spaces. + // Expressed in units of "R indents", not in number of spaces. public final int indent; // The text content after whatever indent.