10000 Clean up API documentation by 0golovatyi · Pull Request #420 · tableau/TabPy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Clean up API documentation #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/pull_fix_spelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Fix spelling on push

on: [push]

jobs:
build:
name: ${{ matrix.python-version }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}

strategy:
matrix:
python-version: [3.7]
os: [ubuntu-latest]

steps:
- uses: actions/checkout@v2
- uses: sobolevn/misspell-fixer-action@master
- uses: peter-evans/create-pull-request@v2.4.4
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: 'Fixes by misspell-fixer'
title: 'Typos fix by misspell-fixer'
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2016 Tableau
Copyright (c) 2016 Tableau Software, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![PyPI version](https://badge.fury.io/py/tabpy.svg)](https://pypi.python.org/pypi/tabpy/)
![Release](https://img.shields.io/github/release/tableau/TabPy.svg)

TabPy (the Tableau Python Server) is an Analytices Extension implementation which
TabPy (the Tableau Python Server) is an Analytics Extension implementation which
expands Tableau's capabilities by allowing users to execute Python scripts and
saved functions via Tableau's table calculations.

Expand All @@ -30,7 +30,7 @@ Consider reading TabPy documentation in the following order:

Troubleshooting:

* [FAQ for configuration, startup and other issues](docs/FAQ.md)
* [TabPy Wiki](https://github.com/tableau/TabPy/wiki)

More technical topics:

Expand Down
26 changes: 0 additions & 26 deletions docs/FAQ.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/TableauConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

## Configuration

Once you have a [TabPy instance](server-startup.md) set up you can easily
Once you have a [TabPy instance](server-install.md) set up you can easily
configure Tableau to use this service for evaluating Python code.

### Tableau Desktop
Expand Down
280 changes: 0 additions & 280 deletions docs/api-v1.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Configuration parameters can be updated with:
1. Adding environment variables - set the environment variable as required by
your Operating System. When creating environment variables, use the same
name for your environment variable as specified in the config file.
2. Specifying a parameter in a config file (enviroment variable value overwrites
2. Specifying a parameter in a config file (environment variable value overwrites
configuration setting).

Configuration file with custom settings is specified as a command line parameter:
Expand Down
2 changes: 1 addition & 1 deletion docs/server-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ and specify it in command line:
tabpy --config=path/to/my/config/file.conf
```

It is highly recommended to use Python virtual enviroment for running TabPy.
It is highly recommended to use Python virtual environment for running TabPy.
Check the [Running TabPy in Python Virtual Environment](tabpy-virtualenv.md) page
for more details.
Loading
0