Skip to content

Commit dbccd47

Browse files
update in doc string
1 parent 954b0de commit dbccd47

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

shotgun_api3/shotgun.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1829,14 +1829,19 @@ def work_schedule_update(
18291829
def export_page(self, page_id, format, layout_name=None):
18301830
"""
18311831
Export the specified page to the given format.
1832-
This method allows you to export a page to a specific format such as CSV.
1832+
This method allows you to export a page to CSV.
1833+
Respective layout or page should be marked as API Exportable in the Shotgun UI. << link to the web documentaion>>
1834+
1835+
If ``layout_name`` is not passed in, the default layout name will be used.
18331836
18341837
>>> sg.export_page(12345, "csv", layout_name="My Layout")
1838+
"ID,Name,Status\\n1,Shot 001,ip\\n2, Shot 002,rev\\n"
1839+
>>> sg.export_page(12345, "csv")
18351840
"ID,Name,Status\\n1,Shot 001,ip\\n2,Shot 002,rev\\n"
18361841
18371842
:param int page_id: The ID of the page to export.
18381843
:param str format: The format to export the page to. Supported format is ``"csv"``.
1839-
:param str layout_name: The name of the layout to export this will map to the layout_display_name field. Defaults to ``None``.
1844+
:param str layout_name: optional layout name. This should be the name of the layout seen in the Shotgun UI.
18401845
:returns: string containing data of the given page.
18411846
:rtype: string
18421847
"""

0 commit comments

Comments
 (0)