Skip to content

Commit

Permalink
Fix new ext READMEs (#444)
Browse files Browse the repository at this point in the history
Some of the new ext packages had ReStructuredText errors. PyPI rejected the uploads for these packages with:

HTTPError: 400 Client Error: The description failed to render for 'text/x-rst'. See https://pypi.org/help/#description-content-type for more information. for url: https://upload.pypi.org/legacy/
  • Loading branch information
c24t committed Feb 24, 2020
1 parent ed25287 commit a4e7a9a
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions ext/opentelemetry-ext-dbapi/README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
OpenTelemetry Database API integration
=================================
======================================

The trace integration with Database API supports libraries following the specification.

Expand All @@ -8,7 +8,7 @@ The trace integration with Database API supports libraries following the specifi
Usage
-----

.. code:: python
.. code-block:: python
import mysql.connector
from opentelemetry.trace import tracer_provider
Expand Down
4 changes: 2 additions & 2 deletions ext/opentelemetry-ext-mysql/README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
OpenTelemetry MySQL integration
=================================
===============================

The integration with MySQL supports the `mysql-connector`_ library and is specified
to ``trace_integration`` using ``'MySQL'``.

.. mysql-connector: https://pypi.org/project/mysql-connector/
.. _mysql-connector: https://pypi.org/project/mysql-connector/

Usage
-----
Expand Down
2 changes: 1 addition & 1 deletion ext/opentelemetry-ext-prometheus/README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
OpenTelemetry Prometheus Exporter
=============================
=================================

|pypi|

Expand Down
7 changes: 4 additions & 3 deletions ext/opentelemetry-ext-psycopg2/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ OpenTelemetry Psycopg integration
The integration with PostgreSQL supports the `Psycopg`_ library and is specified
to ``trace_integration`` using ``'PostgreSQL'``.

.. Psycopg: http://initd.org/psycopg/
.. _Psycopg: http://initd.org/psycopg/

Usage
-----

.. code:: python
.. code-block:: python
import psycopg2
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
Expand All @@ -26,4 +27,4 @@ Usage
References
----------
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_

0 comments on commit a4e7a9a

Please sign in to comment.