picker with annotation

[GarethAres]

Description

Add annotations to the API in template/python/dut.py

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration

• Test A
• Test B

Test Configuration:

• Firmware version:
• Hardware:
• Toolchain:
• SDK:

Checklist:

• My code follows the style guidelines of this project
• I have added the appropriate labels
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[Copilot]

Pull Request Overview

This PR adds comprehensive docstring annotations to the API methods in the DUT (Device Under Test) class in template/python/dut.py. The changes enhance code documentation by providing clear descriptions, parameter information, and return value details for all public methods.

• Added docstrings for all 23 public API methods in the DUT class
• Updated existing docstring format for WaveformPaused method to match new style
• Improved documentation consistency across synchronous and asynchronous APIs

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

There are trailing spaces after 'dut' in the return type description.

Suggested change

	XPort: the XPort of dut
	XPort: the XPort of dut

[Copilot]

There is a trailing space after 'dut' in the return type description.

Suggested change

	XClock: the XClock of dut
	XClock: the XClock of dut

[Copilot]

Missing space after colon and trailing spaces after 'file' in the parameter description.

[Copilot]

Missing space after colon and trailing spaces after 'file' in the parameter description.

[Copilot]

There are trailing spaces after 'file' in the parameter description.

[Copilot]

There are trailing spaces after 'file' in the parameter description.

Suggested change

	name(str): the name of file
	name(str): the name of file

[Copilot]

The parameter description for 'index' is incomplete. It should explain what the index parameter is used for.

Suggested change

	index(int):
	index(int): the index of the internal signal to retrieve. Use a non-negative value to select a specific element for non-array signals; for array signals or VPI signals, index must be negative (typically -1).