Skip to content

Commit 3863180

Browse files
committed
address review feedback
1 parent 96c4a9c commit 3863180

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

describe.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -405,9 +405,9 @@ def document_api(
405405
uri (str): URI of the API's discovery document
406406
doc_destination_dir (str): relative path where the reference
407407
documentation should be saved.
408-
artifact_destination_dir (str): relative path where the discovery
408+
artifact_destination_dir (Optional[str]): relative path where the discovery
409409
artifacts should be saved.
410-
discovery_uri_template (str): URI template of the API's discovery document.
410+
discovery_uri_template (Optional[str]): URI template of the API's discovery document.
411411
If this parameter is set, the `uri` parameter is ignored and the uri
412412
will be created from this template.
413413
"""
@@ -515,12 +515,13 @@ def generate_all_api_documents(
515515
"""Retrieve discovery artifacts and fetch reference documentations
516516
for all apis listed in the public discovery directory.
517517
args:
518-
directory_uri (str): uri of the public discovery directory.
519-
doc_destination_dir (str): relative path where the reference
518+
directory_uri (Optional[str]): uri of the public discovery directory.
519+
doc_destination_dir (Optional[str]): relative path where the reference
520520
documentation should be saved.
521-
artifact_destination_dir (str): relative path where the discovery
521+
artifact_destination_dir (Optional[str]): relative path where the discovery
522522
artifacts should be saved.
523-
discovery_uri_template (str): URI template of the API's discovery document.
523+
discovery_uri_template (Optional[str]): URI template of the API's discovery
524+
document.
524525
"""
525526
api_directory = collections.defaultdict(list)
526527
http = build_http()

0 commit comments

Comments
 (0)