Skip to content

Commit

Permalink
minor documentation fixes (#814)
Browse files Browse the repository at this point in the history
* fix typo in oauth docstring

* rephrased copy docstring to avoid confusion

* fix typos in a handful of models docstrings
  • Loading branch information
hkuffel committed Sep 25, 2020
1 parent 56d595b commit db2a424
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions gspread/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@ def oauth(scopes=DEFAULT_SCOPES, flow=local_server_flow):
gc = gspread.oauth()
Another option is to run a console strategy. This way the user is
Another option is to run a console strategy. This way, the user is
instructed to open the authorization URL in their browser. Once the
authorization is complete the user then must copy & paste
authorization code the application::
authorization is complete, the user must then copy & paste the
authorization code into the application::
gc = gspread.oauth(flow=gspread.auth.console_flow)
Expand Down
8 changes: 4 additions & 4 deletions gspread/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,9 +212,9 @@ def copy(self, file_id, title=None, copy_permissions=False):
.. note::
If you're using custom credentials without Drive scope, in order to use
this method, you need to add ``https://www.googleapis.com/auth/drive``
to your OAuth scope.
If you're using custom credentials without the Drive scope, you need to add
``https://www.googleapis.com/auth/drive`` to your OAuth scope in order to use
this method.
Example::
Expand All @@ -223,7 +223,7 @@ def copy(self, file_id, title=None, copy_permissions=False):
'https://www.googleapis.com/auth/drive'
]
Otherwise you will get an ``Insufficient Permission`` error
Otherwise, you will get an ``Insufficient Permission`` error
when you try to copy a spreadsheet.
"""
Expand Down
6 changes: 3 additions & 3 deletions gspread/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ def values_batch_update(self, params=None, body=None):
return r.json()

def _spreadsheets_get(self, params=None):
"""A method stub that directly calls `spreadsheets.batchUpdate <https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/get>`_. """
"""A method stub that directly calls `spreadsheets.get <https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/get>`_. """
url = SPREADSHEET_URL % self.id
r = self.client.request('get', url, params=params)
return r.json()
Expand Down Expand Up @@ -1674,7 +1674,7 @@ def delete_dimension(self, dimension, start_index, end_index=None):
return self.spreadsheet.batch_update(body)

def delete_rows(self, start_index, end_index=None):
"""Deletes multi rows from the worksheet at the specified index.
"""Deletes multiple rows from the worksheet at the specified index.
:param int start_index: Index of a first row for deletion.
:param int end_index: Index of a last row for deletion.
Expand All @@ -1693,7 +1693,7 @@ def delete_rows(self, start_index, end_index=None):
return self.delete_dimension('ROWS', start_index, end_index)

def delete_columns(self, start_index, end_index=None):
"""Deletes multi columns from the worksheet at the specified index.
"""Deletes multiple columns from the worksheet at the specified index.
:param int start_index: Index of a first column for deletion.
:param int end_index: Index of a last column for deletion.
Expand Down

0 comments on commit db2a424

Please sign in to comment.