Merge pull request #343 from abafzal/dtype

Documentation for setting `dtype=str` before passing dataframe to `create_from_dataframe`
Datatamer · Mar 23, 2020 · ab63374 · ab63374
2 parents c08704d + 9e99dbb
commit ab63374
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,6 +35,7 @@
 
   **BUG FIXES**
   - Links from our docs to the `requests` docs were outdated. Links have been updated to point to the new `requests` docs URL.
+  - [#323](https://github.com/Datatamer/tamr-client/issues/323) Documentation for setting `dtype=str` before calling `client.datasets.create_from_dataframe`
 
 ## 0.10.0
   **BREAKING CHANGES**

diff --git a/docs/user-guide/spec.md b/docs/user-guide/spec.md
@@ -59,8 +59,8 @@ This makes it easy to create a Tamr dataset from a CSV:
 ```python
 import pandas as pd
 
-df = pd.read_csv("my_data.csv")
-dataset = tamr.datasets.create_from_dataframe(df, "primary key name", "My Data")
+df = pd.read_csv("my_data.csv", dtype=str)      # string is the recommended data type
+dataset = tamr.datasets.create_from_dataframe(df, primary_key_name="primary key name", dataset_name="My Data")
 ```
 
 This will create a dataset called "My Data" with the specified primary key, an attribute