From ffac3c9d75fe0d65e14fdab77f4bc98ac6e634e7 Mon Sep 17 00:00:00 2001 From: Kumi Date: Thu, 15 Sep 2022 16:57:33 +0000 Subject: [PATCH] A little bit of documentation --- src/pycruisemapper/classes/api.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/pycruisemapper/classes/api.py b/src/pycruisemapper/classes/api.py index 515f818..973b707 100644 --- a/src/pycruisemapper/classes/api.py +++ b/src/pycruisemapper/classes/api.py @@ -47,6 +47,9 @@ class CruiseMapper: MeinSchiff1 = list(filter(lambda x: x.imo == 9783564))[0] + You may then pass that object into fill_ship() to retrieve additional + data from the ship.json endpoint. + Returns: List[Ship]: A list of Ship objects for all ships """