Added Note about singular retrieval exceptions

This commit is contained in:
Samuel Roach 2022-06-05 21:38:55 +01:00
parent e44046729e
commit 4ef3c06c15

View File

@ -57,7 +57,7 @@ Queries can then be built up with function calls in a sequential manner. Once yo
race_results = e.season(2008).round(5).get_results()
# http://ergast.com/api/f1/drivers/massa
felipe_massa = e.driver_str("massa").get_drivers()
felipe_massa = e.driver_str("massa").get_driver()
# http://ergast.com/api/f1/current/constructorStandings/3
constructor_standings = e.season().standing(3).get_constructor_standings()
@ -146,6 +146,8 @@ More detail on the available functions within the ``Ergast()`` class is availabl
<summary><b>RETURN</b> functions</summary>
</br>
> NOTE: All the return types that return a single object will raise an Exception if your query is returning more than one item.
| Name | Return Type |
| ------------------------- | --------------------- |
| get_circuits | list[Circuit] |