Skip to content

Commit 2967119

Browse files
more clear docstrings
Signed-off-by: varun-edachali-dbx <varun.edachali@databricks.com>
1 parent 267c9f4 commit 2967119

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

src/databricks/sql/backend/sea/models/requests.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
@dataclass
1212
class StatementParameter:
13-
"""Parameter for a SQL statement."""
13+
"""Representation of a parameter for a SQL statement."""
1414

1515
name: str
1616
value: Optional[str] = None
@@ -19,7 +19,7 @@ class StatementParameter:
1919

2020
@dataclass
2121
class ExecuteStatementRequest:
22-
"""Request to execute a SQL statement."""
22+
"""Representation of a request to execute a SQL statement."""
2323

2424
session_id: str
2525
statement: str
@@ -65,7 +65,7 @@ def to_dict(self) -> Dict[str, Any]:
6565

6666
@dataclass
6767
class GetStatementRequest:
68-
"""Request to get information about a statement."""
68+
"""Representation of a request to get information about a statement."""
6969

7070
statement_id: str
7171

@@ -76,7 +76,7 @@ def to_dict(self) -> Dict[str, Any]:
7676

7777
@dataclass
7878
class CancelStatementRequest:
79-
"""Request to cancel a statement."""
79+
"""Representation of a request to cancel a statement."""
8080

8181
statement_id: str
8282

@@ -87,7 +87,7 @@ def to_dict(self) -> Dict[str, Any]:
8787

8888
@dataclass
8989
class CloseStatementRequest:
90-
"""Request to close a statement."""
90+
"""Representation of a request to close a statement."""
9191

9292
statement_id: str
9393

src/databricks/sql/backend/sea/models/responses.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def _parse_result(data: Dict[str, Any]) -> ResultData:
8585

8686
@dataclass
8787
class ExecuteStatementResponse:
88-
"""Response from executing a SQL statement."""
88+
"""Representation of the response from executing a SQL statement."""
8989

9090
statement_id: str
9191
status: StatementStatus
@@ -105,7 +105,7 @@ def from_dict(cls, data: Dict[str, Any]) -> "ExecuteStatementResponse":
105105

106106
@dataclass
107107
class GetStatementResponse:
108-
"""Response from getting information about a statement."""
108+
"""Representation of the response from getting information about a statement."""
109109

110110
statement_id: str
111111
status: StatementStatus
@@ -125,7 +125,7 @@ def from_dict(cls, data: Dict[str, Any]) -> "GetStatementResponse":
125125

126126
@dataclass
127127
class CreateSessionResponse:
128-
"""Response from creating a new session."""
128+
"""Representation of the response from creating a new session."""
129129

130130
session_id: str
131131

0 commit comments

Comments
 (0)