Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tmadlener committed Jul 25, 2023
1 parent fef1d00 commit 06ab6da
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion python/podio/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,18 @@ def get(self, name):
def put(self, collection, name):
"""Put the collection into the frame
The passed collectoin is "moved" into the Frame, i.e. it cannot be used any
longer after a call to this function. This also means that only objects that
were in the collection at the time of calling this function will be
available afterwards.
Args:
collection (podio.CollectionBase): The collection to put into the Frame
name (str): The name of the collection
Returns:
podio.CollectionBase: The reference to the collection that has been put
into the Frame
into the Frame. NOTE: That mutating this collection is not allowed.
Raises:
ValueError: If collection is not actually a podio.CollectionBase
Expand Down

0 comments on commit 06ab6da

Please sign in to comment.