From a3f08f5e8c2313584d7fa28a40675fece308046a Mon Sep 17 00:00:00 2001 From: Phillip Weinberg Date: Fri, 20 Oct 2023 15:32:37 -0400 Subject: [PATCH] adding doc string for `get_capabilities`. --- src/bloqade/submission/capabilities.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/bloqade/submission/capabilities.py b/src/bloqade/submission/capabilities.py index 041516fa3..7f2818a17 100644 --- a/src/bloqade/submission/capabilities.py +++ b/src/bloqade/submission/capabilities.py @@ -4,7 +4,12 @@ # TODO: Create unit converter for capabilities -def get_capabilities(): +def get_capabilities() -> QuEraCapabilities: + """Get the device capabilities for Aquila + + Returns: + QuEraCapabilities: capabilities object for Aquila + """ base_path = os.path.dirname(__file__) full_path = os.path.join( base_path, "quera_api_client", "config", "capabilities.json"