Repository navigation
Document encodings.idna limitations #86699
Description
| BPO | 42533 |
|---|---|
| Nosy | @tiran, @ezio-melotti, @rixx |
| Superseder |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2020-12-02.09:54:58.821>
labels = ['type-feature', '3.10', 'expert-unicode', 'docs']
title = 'Document encodings.idna limitations'
updated_at = <Date 2020-12-02.12:18:41.070>
user = 'https://github.com/rixx'bugs.python.org fields:
activity = <Date 2020-12-02.12:18:41.070>
actor = 'christian.heimes'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Unicode']
creation = <Date 2020-12-02.09:54:58.821>
creator = 'rixx'
dependencies = []
files = []
hgrepos = []
issue_num = 42533
keywords = []
message_count = 2.0
messages = ['382300', '382308']
nosy_count = 4.0
nosy_names = ['christian.heimes', 'ezio.melotti', 'docs@python', 'rixx']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = '17305'
type = 'enhancement'
url = 'https://bugs.python.org/issue42533'
versions = ['Python 3.10']
Activity
rixx commentedon Dec 2, 2020
The documentation for the encodings.idna module contains no indicator that the RFC it supports has been obsoleted by another RFC: https://docs.python.org/3.10/library/codecs.html#module-encodings.idna
I'm sure this is obvious when you know your RFCs, but when just looking at the docs, it's easy to miss. In #msg379674, Marc-Andre suggested to fix the situation by deprecating or updating IDNA support. I'd like to propose to add a warning message in the meantime, pointing out the newer RFC and linking to the idna package on PyPI (if links to PyPI packages are alright in the docs?)
tiran commentedon Dec 2, 2020
+1 for updating our documentation.
Please use bpo-17305. The ticket contains more information on the issue.
StanFromIreland commentedon Jul 11, 2025
This has already been resolved, the docs currently have, exactly as requested:
Closing as duplicate of the issue of the above commit 1d023e3