classification
Title: Missing getlines func documentation from linecache module
Type: Stage: resolved
Components: Documentation Versions: Python 3.8
process
Status: closed Resolution: duplicate
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, khalidmammadov, xtreak
Priority: normal Keywords: patch

Created on 2020-01-01 14:29 by khalidmammadov, last changed 2020-02-22 19:47 by khalidmammadov. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 17784 closed khalidmammadov, 2020-01-01 15:16
Messages (4)
msg359159 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2020-01-01 14:38
As a note getlines is not exposed via __all__ : https://github.com/python/cpython/blob/22424c02e51fab3b62cbe255d0b87d1b55b9a6c3/Lib/linecache.py#L13
msg362472 - (view) Author: Khalid Mammadov (khalidmammadov) * Date: 2020-02-22 19:33
How to find if it was intentional or over-site?
msg362473 - (view) Author: Ammar Askar (ammar2) * (Python triager) Date: 2020-02-22 19:36
A good place to start is looking at the blame to find the commit that introduced it. Which was:

https://github.com/python/cpython/commit/17ab123cf1f0597e7e257c1ce83a6e87b85ffd7b#diff-71666751dc5821f7fc30e9c8138019c9

and if we browse to the state of the file before that commit we see:

https://github.com/python/cpython/blob/bbd89b66b1b3c44836f560b60c7a176a6172f148/Lib/linecache.py#L32-L39

which indicates that it used to be exposed but was maybe overlooked when __all__ was added.
msg362474 - (view) Author: Khalid Mammadov (khalidmammadov) * Date: 2020-02-22 19:44
Looks like it's not meant to be made public as the module is meant to be working on a single line. So closing the issue and PR
History
Date User Action Args
2020-02-22 19:47:28khalidmammadovsetresolution: duplicate
2020-02-22 19:44:30khalidmammadovsetstatus: open -> closed

nosy: - ammar2
messages: + msg362474

stage: patch review -> resolved
2020-02-22 19:36:21ammar2setnosy: + ammar2
messages: + msg362473
2020-02-22 19:33:38khalidmammadovsetmessages: + msg362472
2020-01-01 15:16:12khalidmammadovsetkeywords: + patch
stage: patch review
pull_requests: + pull_request17216
2020-01-01 14:38:56xtreaksetnosy: + xtreak
messages: + msg359159
2020-01-01 14:29:09khalidmammadovcreate