Skip to content

Commit

Permalink
Fix some typos.
Browse files Browse the repository at this point in the history 
Signed-off-by: Gabriel Linder <[email protected]>
  • Loading branch information
@dargor
dargor committed Oct 9, 2018
1 parent fd6464e commit 63a4159
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ A full list is provided below.

## Example code

All example code is available on GitHub (see [package](https://github.com/cloudflare/python-cloudflare) in the [examples](https://github.com/cloudflare/python-cloudflare/tree/master/examples) folder.
All example code is available on GitHub (see [package](https://github.com/cloudflare/python-cloudflare) in the [examples](https://github.com/cloudflare/python-cloudflare/tree/master/examples) folder).

## Blog

Expand Down Expand Up @@ -91,8 +91,8 @@ if __name__ == '__main__':
main()
```

In order to query more than a single page of zones, we would have to use the raw mode (decribed more below).
We can loop over many get calls and pass the page paramater to facilitate the paging.
In order to query more than a single page of zones, we would have to use the raw mode (described more below).
We can loop over many get calls and pass the page parameter to facilitate the paging.

Raw mode is only needed when a get request has the possibility of returning many items.

Expand Down Expand Up @@ -170,7 +170,7 @@ if __name__ == '__main__':

## Providing Cloudflare Username and API Key

When you create a **CloudFlare** class you can pass up to four paramaters.
When you create a **CloudFlare** class you can pass up to four parameters.

* Account email
* Account API key
Expand All @@ -193,7 +193,7 @@ import CloudFlare
cf = CloudFlare.CloudFlare(email='[email protected]', token='00000000000000000000000000000000', certtoken='v1.0-...')
```

If the account email and API key are not passed when you create the class, then they are retreived from either the users exported shell environment variables or the .cloudflare.cfg or ~/.cloudflare.cfg or ~/.cloudflare/cloudflare.cfg files, in that order.
If the account email and API key are not passed when you create the class, then they are retrieved from either the users exported shell environment variables or the .cloudflare.cfg or ~/.cloudflare.cfg or ~/.cloudflare/cloudflare.cfg files, in that order.

There is one call that presently doesn't need any email or token certification (the */ips* call); hence you can test without any values saved away.

Expand Down Expand Up @@ -313,7 +313,7 @@ import CloudFlare
The other raised response is **CloudFlareInternalError** which can happen when calling an invalid method.

In some cases more than one error is returned. In this case the return value **e** is also an array.
You can itterate over that array to see the additional error.
You can iterate over that array to see the additional error.

```python
import sys
Expand Down Expand Up @@ -432,7 +432,7 @@ $ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--

```

### CLI paramaters for POST/PUT/PATCH
### CLI parameters for POST/PUT/PATCH

For API calls that need to pass data or parameters there is various formats to use.

Expand Down Expand Up @@ -551,7 +551,7 @@ $

### Cloudflare CA CLI examples

Here's some Cloudflare CA examples. Note the need of the zone_id= paramater with the basic **/certificates** call.
Here's some Cloudflare CA examples. Note the need of the zone_id= parameter with the basic **/certificates** call.

```bash
$ cli4 /zones/:example.com | jq -c '.|{"id":.id,"name":.name}'
Expand Down Expand Up @@ -852,7 +852,7 @@ $ cli4 /zones/:example.com/workers/routes
$
```

With that script added to the zone and the route added, we can now see the the website has been modified because of the Cloudflare Worker.
With that script added to the zone and the route added, we can now see the website has been modified because of the Cloudflare Worker.

```
$ curl -sS https://example.com/ | fgrep '<body'
Expand Down
16 changes: 8 additions & 8 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Example code
All example code is available on GitHub (see
`package <https://github.com/cloudflare/python-cloudflare>`__ in the
`examples <https://github.com/cloudflare/python-cloudflare/tree/master/examples>`__
folder.
folder).

Blog
----
Expand Down Expand Up @@ -113,7 +113,7 @@ the zones. Lets also query 100 zones.
In order to query more than a single page of zones, we would have to use
the raw mode (decribed more below). We can loop over many get calls and
pass the page paramater to facilitate the paging.
pass the page parameter to facilitate the paging.

Raw mode is only needed when a get request has the possibility of
returning many items.
Expand Down Expand Up @@ -194,7 +194,7 @@ Providing Cloudflare Username and API Key
-----------------------------------------

When you create a **CloudFlare** class you can pass up to four
paramaters.
parameters.

- Account email
- Account API key
Expand All @@ -218,7 +218,7 @@ paramaters.
cf = CloudFlare.CloudFlare(email='[email protected]', token='00000000000000000000000000000000', certtoken='v1.0-...')
If the account email and API key are not passed when you create the
class, then they are retreived from either the users exported shell
class, then they are retrieved from either the users exported shell
environment variables or the .cloudflare.cfg or ~/.cloudflare.cfg or
~/.cloudflare/cloudflare.cfg files, in that order.

Expand Down Expand Up @@ -354,7 +354,7 @@ The other raised response is **CloudFlareInternalError** which can
happen when calling an invalid method.

In some cases more than one error is returned. In this case the return
value **e** is also an array. You can itterate over that array to see
value **e** is also an array. You can iterate over that array to see
the additional error.

.. code:: python
Expand Down Expand Up @@ -481,7 +481,7 @@ convert domain names on-the-fly into zone\_identifier's.
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [-d|--dump] [--get|--patch|--post|--put|--delete] [item=value ...] /command...
CLI paramaters for POST/PUT/PATCH
CLI parameters for POST/PUT/PATCH
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For API calls that need to pass data or parameters there is various
Expand Down Expand Up @@ -614,7 +614,7 @@ Cloudflare CA CLI examples
~~~~~~~~~~~~~~~~~~~~~~~~~~

Here's some Cloudflare CA examples. Note the need of the zone\_id=
paramater with the basic **/certificates** call.
parameter with the basic **/certificates** call.

.. code:: bash
Expand Down Expand Up @@ -936,7 +936,7 @@ Next step is to make sure a route is added for that script on that zone.
$

With that script added to the zone and the route added, we can now see
the the website has been modified because of the Cloudflare Worker.
the website has been modified because of the Cloudflare Worker.

::

Expand Down

0 comments on commit 63a4159

Please sign in to comment.