[New-bugs-announce] [issue34817] Ellipsis docs has extra dot in the markdown that makes it look like .... (four dots)

Karthikeyan Singaravelan report at bugs.python.org
Thu Sep 27 03:14:59 EDT 2018


New submission from Karthikeyan Singaravelan <tir.karthi at gmail.com>:

I looked up the Ellipsis documentation at https://docs.python.org/dev/library/constants.html#Ellipsis which has the below text : 

> The same as .... Special value used mostly in conjunction with extended slicing syntax for user-defined container data types.

The three dots are marked with backtick and look like codeblock but on a light theme it looks like a CSS issue. The backtick contains the actual ellipsis value (...) but the . at the end makes it look like .... especially since I was also using custom dark theme for https://docs.python.org so I thought it was four dots instead of three dots.

Markdown text at https://github.com/python/cpython/blob/master/Doc/library/constants.rst

> The same as ``...``.  Special used mostly in conjunction with extended slicing syntax for user-defined container data types.

It's very trivial but I thought to add a report and I am fine with a won't fix for this. I thought to add a PR but English is not my first language and I don't know if it can worded better. I can change it to "The same as ... which is a special value used mostly in conjunction with extended slicing syntax for user-defined container data types." to avoid the misleading dot and feedback welcome.

Thanks

----------
assignee: docs at python
components: Documentation
messages: 326529
nosy: docs at python, xtreak
priority: normal
severity: normal
status: open
title: Ellipsis docs has extra dot in the markdown that makes it look like .... (four dots)
type: enhancement
versions: Python 3.6, Python 3.7, Python 3.8

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue34817>
_______________________________________


More information about the New-bugs-announce mailing list