Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

Commit

Permalink
add missing docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: Joey Yu <[email protected]>
  • Loading branch information
itsjoeoui committed Oct 16, 2023
1 parent b0451ee commit 44f995a
Show file tree
Hide file tree
Showing 14 changed files with 216 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": null,
"parameters": [
{
"name": "None",
"type": null,
"description": null
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "Traceback error"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"description": "Input\n-----\nvelocity : Scalar\n Servo velocity (10k ticks/sec [1, 15]).",
"parameters": [],
"returns": [
{
"name": null,
"type": "Textblob",
"description": "Traceback error (if any)"
}
]
}
22 changes: 22 additions & 0 deletions IO/PROTOCOLS/CAN/CANABLE/CAN_MESSAGE/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"description": "Inputs\n------\nmessage : Vector\n The array of data to send to the CAN bus.",
"parameters": [
{
"name": "arbitration_id",
"type": "int",
"description": "Unique ID for message being sent."
},
{
"name": "is_extended_id",
"type": "bool",
"description": "Flag that controls the size of the arbitration_id field."
}
],
"returns": [
{
"name": null,
"type": "Textblob",
"description": "Traceback error"
}
]
}
17 changes: 17 additions & 0 deletions IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_ADDR/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": "Inputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.",
"parameters": [
{
"name": "connection",
"type": "Serial",
"description": "The open serial connection with the instrument."
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "Response from the Prologix USB-to-GPIB controller."
}
]
}
17 changes: 17 additions & 0 deletions IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_AUTO/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": "When Read-After-Write is on, the Prologix USB-to-GPIB controller automatically reads a bench-top instrument's response after writing a command to it.\n\nInputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.",
"parameters": [
{
"name": "connection",
"type": "Serial",
"description": "The open serial connection with the instrument."
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "Response from the Prologix USB-to-GPIB controller."
}
]
}
17 changes: 17 additions & 0 deletions IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_HELP/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": "Inputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.",
"parameters": [
{
"name": "connection",
"type": "Serial",
"description": "The open serial connection with the instrument."
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "A list of available Prologix USB-to-GPIB firmware commands"
}
]
}
17 changes: 17 additions & 0 deletions IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_MODE/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": "From the Prologix manual:\n\nIn Controller mode, the GPIB-USB Controller acts as the Controller-In-Charge (CIC)\non the GPIB bus. When the controller receives a command over the USB port\nterminated by the USB terminator \u2013 CR (ASCII 13) or LF (ASCII 10) \u2013 it addresses the\nGPIB instrument at the currently specified address (See ++addr command) to listen, and\npasses along the received data.\n\nIn Device mode, Prologix GPIB-USB Controller acts as another peripheral on the GPIB\nbus. In this mode, the controller can act as a GPIB TALKER or GPIB LISTENER\nonly. Since Prologix GPIB-USB Controller is not the Controller-In-Charge while in this\nmode, it expects to receive commands from a GPIB controller. When Device mode is\nenabled Prologix GPIB-USB controller configures itself as a GPIB Listener. All data\nreceived by the controller over the GPIB port is passed along to the USB port without\nbuffering.\n\nInputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.",
"parameters": [
{
"name": "connection",
"type": "Serial",
"description": "The open serial connection with the instrument."
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "Response from the Prologix USB-to-GPIB controller."
}
]
}
17 changes: 17 additions & 0 deletions IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_VER/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": "Inputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.",
"parameters": [
{
"name": "connection",
"type": "Serial",
"description": "The open serial connection with the instrument."
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "The Prologix controller available commands."
}
]
}
17 changes: 17 additions & 0 deletions IO/PROTOCOLS/SCPI/SCPI_WRITE/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"description": "Inputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.",
"parameters": [
{
"name": "connection",
"type": "Serial",
"description": "The open serial connection with the instrument."
}
],
"returns": [
{
"name": null,
"type": "Scalar|TextBlob",
"description": "The return value from the bench-top instrument as a Scalar or TextBlob."
}
]
}
11 changes: 11 additions & 0 deletions TRANSFORMERS/MATRIX_MANIPULATION/TRANSPOSE_MATRIX/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"description": "Inputs\n------\na : Matrix\n The input matrix to be transposed",
"parameters": [],
"returns": [
{
"name": null,
"type": "Matrix",
"description": "The transposed matrix"
}
]
}
11 changes: 11 additions & 0 deletions TRANSFORMERS/TYPE_CASTING/MATRIX_2_VECTOR/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"description": "Inputs\n------\ndefault: Matrix\n The input matrix that will be transformed into vector data type.",
"parameters": [],
"returns": [
{
"name": null,
"type": "Vector",
"description": "Vector that is flatten from input matrix."
}
]
}
11 changes: 11 additions & 0 deletions TRANSFORMERS/TYPE_CASTING/ORDERED_PAIR_2_VECTOR/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"description": "Inputs\n------\ndefault : OrderedPair\n The input OrderedPair.",
"parameters": [],
"returns": [
{
"name": null,
"type": "Vector",
"description": "The y component of the input OrderedPair."
}
]
}
22 changes: 22 additions & 0 deletions TRANSFORMERS/TYPE_CASTING/VECTOR_2_MATRIX/docstring.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"description": "the shape is chosen by row and col parameters.\n\nInputs\n------\ndefault: Vector\n The input vector that will be transformed into matrix.",
"parameters": [
{
"name": "row",
"type": "int",
"description": "number of rows for the new matrix"
},
{
"name": "col",
"type": "int",
"description": "number of columns for the new matrix"
}
],
"returns": [
{
"name": null,
"type": "Matrix",
"description": "The matrix that is generated from the given vector and the parameters."
}
]
}
12 changes: 9 additions & 3 deletions VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/docstring.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
{
"description": "Inputs\n------\ndefault : TextBlob\n the DataContainer to be visualized in text format",
"parameters": [],
"description": "Inputs\n------\ndefault : TextBlob\n The DataContainer to be visualized in text format",
"parameters": [
{
"name": "prettify",
"type": "Boolean",
"description": "Whether to prettify the displayed text (defaults to True)"
}
],
"returns": [
{
"name": null,
"type": "TextBlob",
"description": "the DataContainer containing text data"
"description": "The DataContainer containing text data"
}
]
}

0 comments on commit 44f995a

Please sign in to comment.