Skip to content

Commit

Permalink
rmm/mongo/loader.py: clarify some in-line documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RayPlante committed Jan 11, 2024
1 parent 5086f5b commit 0d36e4e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion python/nistoar/rmm/mongo/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def disconnect(self):
self._client = None
self._db = None

def load_data(self, data, key=None, onupdate='quiet'):
def load_data(self, data, key=None, onupdate='quiet') -> int:
"""
load the given data document into the configured MongoDB collection.
Expand Down Expand Up @@ -114,6 +114,9 @@ def load_data(self, data, key=None, onupdate='quiet'):
that was used to select it; this function should
return True if the new data should then be loaded
or False if it should not.
:return: the number of database records added; 0 is returned if implementation
decides that it is not necessary to load any records
:rtype: int
"""
try:
if not self._client:
Expand Down

0 comments on commit 0d36e4e

Please sign in to comment.