Skip to content
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

docs: Fix a few typos #100

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
docs: Fix a few typos
There are small typos in:
- README.md
- README.rst
- db/db.py
- db/s3.py
- docs/adding-a-db-checklist.md

Fixes:
- Should read `distribution` rather than `distrobution`.
- Should read `credentials` rather than `crentials`.
- Should read `statement` rather than `statment`.
- Should read `postgres` rather than `portgres`.
- Should read `necessary` rather than `neccessary`.
  • Loading branch information
timgates42 committed Aug 2, 2021
commit 64ca3d690b0bec0a2236ec3ae8f3db26184485a2
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ See either the TODO below or [Adding a Database](./docs/adding-a-db-checklist.md
- [x] mssql (going to be a little trickier since i don't have one)
- [x] publish examples to nbviewer
- [x] improve documentation and readme
- [x] add sample database to distrobution
- [x] add sample database to distribution
- [x] push to Redshift
- [ ] "joins to" for columns
- [x] postgres
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ TODO

- [x] publish examples to nbviewer
- [x] improve documentation and readme
- [x] add sample database to distrobution
- [x] add sample database to distribution
- [x] push to Redshift
- [ ] "joins to" for columns

Expand Down
6 changes: 3 additions & 3 deletions db/db.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class DB(object):
Hostname your database is running on (i.e. "localhost", "10.20.1.248")
port: int
Port the database is running on. defaults to default port for db.
portgres: 5432
postgres: 5432
redshift: 5439
mysql: 3306
sqlite: n/a
Expand Down Expand Up @@ -278,7 +278,7 @@ def __delete__(self):

def load_credentials(self, profile="default"):
"""
Loads crentials for a given profile. Profiles are stored in
Loads credentials for a given profile. Profiles are stored in
~/.db.py_{profile_name} and are a base64 encoded JSON file. This is not
to say this a secure way to store sensitive data, but it will probably
stop your little sister from stealing your passwords.
Expand Down Expand Up @@ -979,7 +979,7 @@ def to_redshift(self, name, df, drop_if_exists=False, chunk_size=10000,
else:
bucket = conn.create_bucket(bucket_name, location=bucket_location)
# we're going to chunk the file into pieces. according to amazon, this is
# much faster when it comes time to run the \COPY statment.
# much faster when it comes time to run the \COPY statement.
#
# see http://docs.aws.amazon.com/redshift/latest/dg/t_splitting-data-files.html
sys.stderr.write("Transfering {0} to s3 in chunks".format(name))
Expand Down
2 changes: 1 addition & 1 deletion db/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def save_credentials(self, profile):

def load_credentials(self, profile):
"""
Loads crentials for a given profile. Profiles are stored in
Loads credentials for a given profile. Profiles are stored in
~/.db.py_s3_{profile_name} and are a base64 encoded JSON file. This is
not to say this a secure way to store sensitive data, but it will
probably stop your little sister from spinning up EC2 instances.
Expand Down
2 changes: 1 addition & 1 deletion docs/adding-a-db-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ all the same). Here's a checklist of what you'll need to do:
- [ ] ref_keys_for_table

Create a file called `foosql.py` and put it in the [`queries`](https://github.com/yhat/db.py/tree/master/db/queries)
directory. Once you've written the neccessary queries, add an import statement
directory. Once you've written the necessary queries, add an import statement
to the `db.py` file. It will look something like this:

```python
Expand Down