yard_to_mileage¶

pyrcs.converter.yard_to_mileage(yard, as_str=True)[source]¶

Converts yards to mileages.

Parameters:

yard (int | float | None) – The yard data.
as_str (bool) – Whether to return as a string value; defaults to True.

Returns:

The mileage in the form of <miles>.<yards> or <miles>.<yards>.

Return type:

str | float

Examples:

>>> from pyrcs.converter import yard_to_mileage
>>> mileage_dat = yard_to_mileage(yard=396)
>>> mileage_dat
'0.0396'
>>> mileage_dat = yard_to_mileage(yard=396, as_str=False)
>>> mileage_dat
0.0396
>>> mileage_dat = yard_to_mileage(yard=None)
>>> mileage_dat
''
>>> mileage_dat = yard_to_mileage(yard=1760)
>>> mileage_dat
'1.0000'
>>> mileage_dat = yard_to_mileage(yard=12330)
>>> mileage_dat
'7.0010'