Skip to content

Commit

Permalink
Merge pull request #83 from signalfx/cory-fix-rst
Browse files Browse the repository at this point in the history
Fix rst syntax
  • Loading branch information
cory-signalfx authored Jul 5, 2019
2 parents 84804b2 + 9d61e58 commit b85ece8
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Installation

To install with `pip`:

.. code::
.. code:: console
$ pip install signalfx
To install from source:

.. code::
.. code:: console
$ git clone https://github.com/signalfx/signalfx-python.git
$ cd signalfx-python/
Expand Down Expand Up @@ -55,10 +55,10 @@ you access to the API client that you want:
# For the SignalFlow API
flow = sfx.signalflow('ACCESS_TOKEN')
If no endpoints are set manually, this library uses the ``us0`` realm by default.
If no endpoints are set manually, this library uses the ``us0`` realm by default.
If you are not in this realm, you will need to explicitly set the
endpoint urls above. To determine if you are in a different realm and need to
explicitly set the endpoints, check your profile page in the SignalFx
explicitly set the endpoints, check your profile page in the SignalFx
web application. You will also need to specify an access token when requesting
one of those clients. For the ingest client, you need to specify your
organization access token (which can be obtained from the
Expand Down Expand Up @@ -245,7 +245,7 @@ metric registry data directly to SignalFx.
def callme():
# whatever
pass
@count_calls_with_dims(dimension_key="dimension_value")
def callme_with_dims():
# whatever
Expand Down Expand Up @@ -273,10 +273,10 @@ computations on the SignalFx platform. For more information, head over to our
Developers documentation:

* `SignalFlow Overview`_
* `Getting started with the SignalFlow API`_
* `SignalFlow API Reference`_

.. _SignalFlow Overview: https://developers.signalfx.com/signalflow_analytics/signalflow_overview.html
.. _SignalFlow API Reference: https://developers.signalfx.com/signalflow_reference.html
.. _SignalFlow API Reference: https://developers.signalfx.com/signalflow_reference.html

The SignalFlow client accepts either an Organization Access Token or a User API Token.
Executing a SignalFlow program is very simple with this client library:
Expand Down Expand Up @@ -352,7 +352,7 @@ when your program exits:
SSLError when working with tags, metrics, dimensions, metrictimeseries, organization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code::
.. code:: console
ERROR:root:Posting to SignalFx failed.
SSLError: hostname 'api.signalfx.com' doesn't match either of '*.signalfuse.com', 'signalfuse.com'.
Expand Down

0 comments on commit b85ece8

Please sign in to comment.