Skip to content

Commit a2d9a90

Browse files
committed
A few minor doc fixes
1 parent 7f1ddd1 commit a2d9a90

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
@@ -34,13 +34,13 @@ Saves any changes to the workbook to a new file specified by the `new_file` para
3434

3535
`self.worksheets:` Returns a list of worksheets found in the workbook.
3636

37-
`self.datasources:` Returns a list of Datasource objects found in the workbook.
37+
`self.datasources:` Returns a list of datasource objects found in the workbook.
3838

3939
`self.filename:` Returns the filename of the workbook.
4040

4141
`self.shapes` Returns a list of strings with the names of shapes found in the workbook.
4242

43-
`self.dashboards:` Returns a list of strings with the names of the dashboards found in the workbook
43+
`self.dashboards:` Returns a list of strings with the names of the dashboards found in the workbook
4444

4545
## Datasources
4646
```python
@@ -149,7 +149,7 @@ Represents a field in a datasource
149149

150150
`self.calculation` Returns a string with the formula if this field is a calculated field.
151151

152-
`self.default_aggregation` Returns a string with he default type of aggregation on the field (e.g Sum, Avg).
152+
`self.default_aggregation` Returns a string with the default type of aggregation on the field (e.g, Sum, Avg).
153153

154154
`self.description` Returns a string with contents of the <desc> tag on a field.
155155

docs/docs/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ somewhere.
6060

6161
## Release process
6262

63-
We expect that everything merged into the development branch is ready to release on master. Releases can be made at any time - ideally it would be on a regular cadence but currently it is basically on request.
63+
We expect that everything merged into the development branch is ready to release on master.
6464
- bump the version in setup.py
6565
- update the changelog: all commits to development should contain a meaningful message, the changelog can be built from these
66-
- merge to master.
67-
This kicks off an automated release in github and then publish to pypi.
66+
- merge to master.
67+
This kicks off an automated release in GitHub and then publish to PyPI.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Features include:
2828
- Server Name
2929
- Username
3030
- Database Name
31-
- Getting Field information from data sources and workbooks
31+
- Getting field information from data sources and workbooks
3232
- Get all fields in a data source
3333
- Get all fields in use by certain sheets in a workbook
3434

35-
For Hyper files, take a look a the [Tableau Hyper API](https://tableau.github.io/hyper-db/docs/).
35+
For Hyper files, take a look at the [Tableau Hyper API](https://tableau.github.io/hyper-db/docs/).
3636

3737
We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information.

0 commit comments

Comments
 (0)