#112: Updating readme to clarify that returned water is in milliliters.

myfitnesspal/client.py

@@ -4,7 +4,7 @@
 import logging
 import re
 from collections import OrderedDict
-from typing import Dict, List, Optional, overload
+from typing import Dict, List, Optional, Union, overload
 
 import lxml.html
 import requests
@@ -667,7 +667,7 @@ def _get_notes(self, date: datetime.date) -> Note:
  )
  return Note(result.json()["item"])
 
- def _get_water(self, date: datetime.date) -> float:
+ def _get_water(self, date: datetime.date) -> Union[float, Volume]:
  result = self._get_request_for_url(
  parse.urljoin(
  self.BASE_URL_SECURE,
@@ -676,10 +676,10 @@ def _get_water(self, date: datetime.date) -> float:
  + "?date={date}".format(date=date.strftime("%Y-%m-%d"))
  )
  value = result.json()["item"]["milliliters"]
- cups = int(Volume(ml=value).us_cup)
- if not self.unit_aware:
- return cups
- return Volume(us_cup=cups)
+ if self.unit_aware:
+  return Volume(ml=value)
+
+ return value
 
  def __str__(self) -> str:
  return f"MyFitnessPal Client for {self.effective_username}"
@@ -797,4 +797,4 @@ def get_food_item_details(self, mfp_id: int) -> FoodItem:
  confirmations=details["confirmations"],
  serving_sizes=details["serving_sizes"],
  client=self,
- )
+ )

readme.markdown

@@ -104,7 +104,7 @@ day.totals
 # 'sugar': 103}
 ```
 
-Or, if you just want to see how many cups of water you've recorded, or the notes you've entered for a day:
+Or, if you just want to see how many milliliters of water you've recorded, or the notes you've entered for a day:
 
 ```python
 day.water