Skip to content

Commit

Permalink
Pydoc style
Browse files Browse the repository at this point in the history
  • Loading branch information
eugenevinitsky committed May 14, 2020
1 parent 2f823d8 commit 91f1498
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions flow/core/kernel/vehicle/base.py
Expand Up @@ -299,6 +299,7 @@ def get_num_not_departed(self):

def get_fuel_consumption(selfself, veh_id, error=-1001):
"""Return the mpg / s of the specified vehicle.
Parameters
----------
veh_id : str or list of str
Expand Down
7 changes: 5 additions & 2 deletions flow/core/rewards.py
Expand Up @@ -334,6 +334,7 @@ def energy_consumption(env, gain=.001):

def veh_energy_consumption(env, veh_id, gain=.001):
"""Calculate power consumption of a vehicle.
Assumes vehicle is an average sized vehicle.
The power calculated here is the lower bound of the actual power consumed
by a vehicle.
Expand All @@ -357,7 +358,8 @@ def veh_energy_consumption(env, veh_id, gain=.001):


def miles_per_megajoule(env, veh_ids=None, gain=.001):
"""Calculate miles per mega-joule of either a particular vehicle or the total average of all the vehilces.
"""Calculate miles per mega-joule of either a particular vehicle or the total average of all the vehicles.
Assumes vehicle is an average sized vehicle.
The power calculated here is the lower bound of the actual power consumed
by a vehicle.
Expand Down Expand Up @@ -398,7 +400,8 @@ def miles_per_megajoule(env, veh_ids=None, gain=.001):


def miles_per_gallon(env, veh_ids=None, gain=.001):
"""Calculate mpg of either a particular vehicle or the total average of all the vehilces.
"""Calculate mpg of either a particular vehicle or the total average of all the vehicles.
Assumes vehicle is an average sized vehicle.
The power calculated here is the lower bound of the actual power consumed
by a vehicle.
Expand Down

0 comments on commit 91f1498

Please sign in to comment.