Skip to content

Commit d60c516

Browse files
authored
Merge pull request RockefellerArchiveCenter#185 from RockefellerArchiveCenter/docstring-update
updates docstrings in routines
2 parents df3d3c1 + 7dd6543 commit d60c516

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

process_request/routines.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -189,14 +189,19 @@ def __init__(self):
189189
}
190190

191191
def get_request_data(self, request_type, baseurl, **kwargs):
192-
"""Delivers request to Aeon.
192+
"""Gets object data from ArchivesSpace and formats it for reading rooom
193+
or duplication requests in Aeon.
193194
194195
Args:
195196
request_type (str): string indicating whether the request is for the
196197
readingroom or duplication.
198+
baseurl (str): Base url for an ArchivesSpace instance.
199+
**kwargs (dict): Includes varying Aeon request information depending
200+
on the type of request. Also includes the below specified keys.
201+
items (list): A list of ArchivesSpace archival object URIs.
197202
198203
Returns:
199-
dict: Request data.
204+
dict: Request data formatted for Aeon.
200205
201206
Raise:
202207
ValueError: if request_type is not readingroom or duplicate.

0 commit comments

Comments
 (0)