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

[Karthikeyan Singaravelan]

Change by Karthikeyan Singaravelan :


--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Karthikeyan Singaravelan]

Karthikeyan Singaravelan  added the comment:

Thanks Martin for the suggestion. I have created a PR with your suggestion and 
added a description in the PR that shows the visual distinction between the 
current doc and suggested change.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Karthikeyan Singaravelan]

Change by Karthikeyan Singaravelan :


--
keywords: +patch
pull_requests: +9140
stage:  -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Martin Panter]

Martin Panter  added the comment:

In these situations, I use quotes or brackets to mention a symbol without using 
it as punctuation. Using words might also help. What about:

Ellipsis
  The same as the ellipsis literal “...”. Special value used [etc]

--
nosy: +martin.panter

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Karthikeyan Singaravelan]

New submission from Karthikeyan Singaravelan :

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@python
components: Documentation
messages: 326529
nosy: docs@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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com