rhinoscriptsyntax

The Example: section should provide code that is functional and can be copied and pasted into an empty script to run immediately.

Requirements for Examples:

1. Must be self-contained.
2. Must include the import rhinoscriptsyntax as rs line.
3. Must not require external .3dm files or support files.
4. Should demonstrate the use of optional arguments if applicable.

def AliasMacro(alias, macro=None):
    """Returns or modifies the macro of a command alias.
    Parameters:
      alias (str): The name of an existing command alias.
      macro (str, optional): The new macro to run when the alias is executed. If omitted, the current alias macro is returned.
    Returns:
      str:  If a new macro is not specified, the existing macro if successful.
      str:  If a new macro is specified, the previous macro if successful.
      null:  None on error
    Example:
      import rhinoscriptsyntax as rs
      aliases = rs.AliasNames()
      for alias in aliases:
          print("{}
 -> {}".format(alias, rs.AliasMacro(alias)))
    See Also:
      AddAlias
      AliasCount
      AliasNames
      DeleteAlias
      IsAlias
    """
    # implementation...

The Parameters: section describes the input arguments. Each parameter line follows the pattern: variable_name (type): description.

Type Notation Rules:

• Simple type: alias (str): description
• List of same type (unlimited): alias ([str, ...]): description
• List of different types: alias ([str, number, bool]): description
• Nested lists: alias ([str, [number, number], bool]): description
• Type OR (Pipe): alias (str|guid): description
• Optional parameters: Add , optional to the type and explain the default behavior (e.g., alias (str, optional): description. If omitted, None is returned.)

# Examples of parameter syntax
alias (str): The name of an existing command alias.
alias ([str, ...]): The name of an existing command alias.
alias ([str, number, bool]): list of an existing command alias.
alias ([str, [number, number], bool]): list of values for command alias.
alias (str|guid): The name or guid identifier of an existing command alias.
alias (str, optional): The name of an existing command alias. If omitted, None is returned.

The Returns: section describes what the function outputs. Even if a function returns None, it must be explicitly listed.

Return Notation Rules:

• Simple type: str: description
• List of same type: list(str, ...): description
• List of different types: list(str, number, bool): description
• Multiple return types: Use separate lines for different conditions:

  str: The name of an existing command alias.
  number: If no argument, returns number of aliases.
  None: If not successful

• Numeric codes: If a number refers to a specific state, list them:

  1 = counter clockwise
  0 = stationary
  -1 = clockwise

• Index numbers: If a number refers to a specific index in a returned collection:

  [0] point for origin
  [1] area of surface

# Examples of return syntax
Returns:
    None

str: The name of an existing command alias.
list(str, ...): A list of alias.
list(str, number, bool): Various information about command alias.

# Multiple return values
str: The name of an existing command alias.
number: If no argument, returns number of aliases.
None: If not successful

# Numeric codes
1 = counter clockwise
0 = stationary
-1 = clockwise

# Index numbers
[0] point for origin
[1] area of surface
[2] point of center