30 lines
799 B
Plaintext
30 lines
799 B
Plaintext
---
|
||
title: my_function1 (latest version)
|
||
description: API reference for api_example.my_function1 in the latest version of qiskit-sphinx-theme
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: api_example.my_function1
|
||
---
|
||
|
||
<span id="api-example-my-function1" />
|
||
|
||
# api\_example.my\_function1
|
||
|
||
<Function id="api_example.my_function1" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit_sphinx_theme/tree/stable/0.1/api_example.py" signature="api_example.my_function1(input1, input2, input3=None, **kwargs)">
|
||
A function that does awesome stuff.
|
||
|
||
**Returns**
|
||
|
||
Did the function work.
|
||
|
||
**Raises**
|
||
|
||
* **ValueError** – If the inputs are not the correct values.
|
||
* **TypeError** – If the inputs are not strings.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
</Function>
|
||
|