search

influxdata / influxdb-client-python

InfluxDB 2.0 python client
https://influxdb-client.readthedocs.io/en/stable/
MIT License
706 stars 185 forks source link

README.rst is not rendered correctly on GitHub #634

Closed twrasmussen closed 7 months ago

twrasmussen commented 7 months ago

Specifications

Code sample to reproduce problem

Expected behavior

Links to v1 client library in readme no longer linked to valid web page

Actual behavior

Links to v1 client library in readme no longer linked to valid web page

Additional info

Links to v1 client library in readme no longer linked to valid web page

powersj commented 7 months ago

It seems like GitHub is not rendering the RST formatted README correctly currently: https://github.com/influxdata/influxdb-client-python

The URL itself is correct, it is that the rendering is incorrect. This is what shows up due to the rendering looking strange:

https://github.com/influxdata/influxdb-python%3E%60_

Given there have been no updates to the README in 6 months, I am thinking this is a GitHub issue or they have changed something

bednar commented 7 months ago

The "rst" format is still supported, as seen here: sphinx-readme README.rst. Therefore, we need to review the syntax of our README.rst to ensure it's correct.

bednar commented 7 months ago

The GitHub uses this project to convert RST to HTML - https://github.com/github/markup