Skip to content

Commit 3d4005a

Browse files
committed
Several docs updates just to catch up with the existing code
Co-authored by Claude Code`
1 parent 22460db commit 3d4005a

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/docs/api-ref.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ A class representing Tableau Data Sources, embedded in workbook files or in TDS
5656

5757
`Datasource.save(self)` Saves any changes to the datasource to the existing file.
5858

59-
`Datasource.save_as(self)` Saves any changes to the datasource to a new file specified by the `new_file` parameter.
59+
`Datasource.save_as(self, new_filename)` Saves any changes to the datasource to a new file specified by the `new_filename` parameter.
6060

61-
`Datasource.add_field(self, name, datatype, role, field_type, caption)` Adds a base field object with the given values.
61+
`Datasource.add_field(self, name, datatype, role, field_type, caption, hidden)` Adds a base field object with the given values.
6262

6363
`Datasource.remove_field(self, field)` Remove a given field.
6464

65-
`Datasource.add_calculation(self, caption, formula, datatype, role, type)` Adds a calculated field with the given values.
65+
`Datasource.add_calculation(self, caption, formula, datatype, role, type, hidden)` Adds a calculated field with the given values.
6666

6767
**Properties:**
6868

docs/docs/dev-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ layout: docs
2626
1. Run the tests to make sure everything is peachy:
2727

2828
```shell
29-
python setup.py test
29+
python -m unittest discover -v
3030
```
3131

3232
1. Set up the feature, fix, or documentation branch.
@@ -49,8 +49,8 @@ layout: docs
4949

5050
1. Add tests.
5151

52-
All of our tests live under the `test/` folder in the repository.
53-
We use `unittest` and the built-in test runner `python setup.py test`.
52+
All of our tests live under the `test/` folder in the repository.
53+
We use `unittest` and run them with `python -m unittest discover -v`.
5454
If a test needs a static file, like a twb/twbx, it should live under `test/assets/`
5555

5656
1. Update the documentation.

docs/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Get Started
33
layout: docs
44
---
55

6-
To use this SDK, you must have Python installed. You can use either 2.7.X or 3.3 and later.
6+
To use this SDK, you must have Python 3 installed. The SDK is tested against Python 3.10 and later. (As of 2021, Python 2 is no longer supported.)
77

88
* TOC
99
{:toc}
@@ -76,7 +76,7 @@ sourceWB.save()
7676
- Import the `Workbook` object from the `tableaudocumentapi` module.
7777
- To open a workbook, instantiate a `Workbook` object and pass the file name as the first argument.
7878
- The `Workbook` object exposes a list of `datasources` in the workbook
79-
- Each data source object has a `connection` object that supports a `server`, `dbname`, and `username` property.
79+
- Each data source object exposes a `connections` list; each connection supports `server`, `dbname`, and `username` properties.
8080
- Save changes to the workbook by calling the `save` or `save_as` method.
8181

8282
<div class="alert alert-info">

0 commit comments

Comments
 (0)