Merge pull request #1446 from burnash/doc/value_render_option_currency

Improce README and documentation with value render options

README.md

@@ -276,6 +276,24 @@ worksheet.batch_update([{
 }])
 ```
 
+### Get unformatted cell value or formula
+
+```python
+from gspread.utils import ValueRenderOption
+
+# Get formatted cell value as displayed in the UI
+>>> worksheet.get("A1:B2")
+[['$12.00']]
+
+# Get unformatted value from the same cell range
+>>> worksheet.get("A1:B2", value_render_option=ValueRenderOption.unformatted)
+[[12]]
+
+# Get formula from a cell
+>>> worksheet.get("C2:D2", value_render_option=ValueRenderOption.formula)
+[['=1/1024']]
+```
+
 ## Documentation
 
 [Documentation]\: [https://gspread.readthedocs.io/][Documentation]

docs/user-guide.rst

@@ -139,6 +139,42 @@ If you want to get a cell formula:
 
    cell = worksheet.cell(1, 2, value_render_option='FORMULA').value
 
+Getting Unformatted Cell Value
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Get the Unformatted value from a cell.
+Example: cells formatted as currency will display with the selected
+currency but they actual value is regular number.
+
+Get the formatted (as displayed) value:
+
+.. code:: python
+
+   worksheet.get("A1:B2")
+
+Results in: ``[['$12.00']]``
+
+Get the unformatted value:
+
+.. code:: python
+
+   from gspread.utils import ValueRenderOption
+   worksheet.get("A1:B2", value_render_option=ValueRenderOption.unformatted)
+
+Results in: ``[[12]]``
+
+Getting Cell formula
+~~~~~~~~~~~~~~~~~~~~
+
+Get the formula from a cell instead of the resulting value:
+
+.. code:: python
+
+   from gspread.utils import ValueRenderOption
+   worksheet.get("G6", value_render_option=ValueRenderOption.formula)
+
+Resulsts in: ``[['=1/1024']]``
+
 
 Getting All Values From a Row or a Column
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~