A little bit of documentation

2022-09-15 16:57:33 +00:00 · 2022-09-15 16:57:33 +00:00 · ffac3c9d75
parent bead4d2fab
commit ffac3c9d75
1 changed files with 3 additions and 0 deletions
--- 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
        """