Skip to content

Commit 2eae970

Browse files
Correct doc_string to docstring.
1 parent 779dd5a commit 2eae970

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

tabpy/tabpy_server/management/state.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ def add_endpoint(
215215
Name of the endpoint
216216
description : str, optional
217217
Description of this endpoint
218-
doc_string : str, optional
218+
docstring : str, optional
219219
The doc string for this endpoint, if needed.
220220
endpoint_type : str
221221
The endpoint type (model, alias)
@@ -309,7 +309,7 @@ def update_endpoint(
309309
Name of the endpoint
310310
description : str, optional
311311
Description of this endpoint
312-
doc_string : str, optional
312+
docstring : str, optional
313313
The doc string for this endpoint, if needed.
314314
endpoint_type : str, optional
315315
The endpoint type (model, alias)

tabpy/tabpy_tools/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ def _gen_endpoint(self, name, obj, description, version=1, schema=None, is_publi
408408
"methods": endpoint_object.get_methods(),
409409
"required_files": [],
410410
"required_packages": [],
411-
"docstring": endpoint_object.get_doc_string(),
411+
"docstring": endpoint_object.get_docstring(),
412412
"schema": copy.copy(schema),
413413
"is_public": is_public,
414414
}

tabpy/tabpy_tools/custom_query_object.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def query(self, *args, **kwargs):
7171
)
7272
raise
7373

74-
def get_doc_string(self):
74+
def get_docstring(self):
7575
"""Get doc string from customized query"""
7676
default_docstring = "-- no docstring found in query function --"
7777

tabpy/tabpy_tools/query_object.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class QueryObject(abc.ABC):
1414
"""
1515
Derived class needs to implement the following interface:
1616
* query() -- given input, return query result
17-
* get_doc_string() -- returns documentation for the Query Object
17+
* get_docstring() -- returns documentation for the Query Object
1818
"""
1919

2020
def __init__(self, description=""):
@@ -30,7 +30,7 @@ def query(self, input):
3030
pass
3131

3232
@abc.abstractmethod
33-
def get_doc_string(self):
33+
def get_docstring(self):
3434
"""Returns documentation for the query object
3535
3636
By default, this method returns the docstring for 'query' method

0 commit comments

Comments
 (0)