This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Add 'symbols' link to pydoc's html menu bar.
Type: enhancement Stage: patch review
Components: Library (Lib) Versions: Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: CuriousLearner, cheryl.sabella, ncoghlan, ron_adam, ronaldoussoren, zach.ware
Priority: normal Keywords: patch

Created on 2013-07-06 17:28 by ron_adam, last changed 2022-04-11 14:57 by admin.

Files
File name Uploaded Description Edit
pdoc_symbols.diff ron_adam, 2013-07-15 18:30 review
Pull Requests
URL Status Linked Edit
PR 13225 open CuriousLearner, 2019-05-09 21:10
Messages (12)
msg192471 - (view) Author: Ron Adam (ron_adam) * Date: 2013-07-06 17:28
This patch adds a 'symbols' link after the 'topics' and 'keywords' links in the html browser menu bar.

help('symbols') worked, but there was no way to get to it in the html browser.

This also adds unquote_plus() to the url handler to unquote the html input form fields.  This is needed to allow entering the symbols.
msg192552 - (view) Author: Ron Adam (ron_adam) * Date: 2013-07-07 13:10
New slightly improved patch.  Combined the topic index's, topics, keywords, and the new symbols case, into a single html_topicsindex(title) function.
msg193063 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2013-07-14 17:47
Just from a bit of testing without looking at the patch very much, there are a couple of things that need to be fixed.  First, the + and += links don't work, tested on Firefox and Konqueror on Linux.  Second, there are a couple of symbols which should have been removed from the listing back in the 3.0 days: <> and `.

I like the idea, though.
msg193073 - (view) Author: Ron Adam (ron_adam) * Date: 2013-07-15 04:35
Thanks for catching that.  I had used unquote_plus instead of unquote.  That is needed for multi-field form data, pydoc doens't need it.

Removed the back tick from the pydoc symbols list.  The topic link for that symbol was already removed.

I also attempted to make the escape() usage a bit better by using the escape function from the html package in more places.  It does just a bit better job of escaping.

I wasn't aware help() would take a "symbols" argument when I added the "keywords" and "topics" pages to the html server.  I've been meaning to get this in for a while.
msg193074 - (view) Author: Ron Adam (ron_adam) * Date: 2013-07-15 04:36
Updated the patch.
msg193115 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2013-07-15 16:14
Aside from '<>' still being present, the patch looks good to me.  There are a couple of issues with content, but those are separate from this issue.  (For instance, '~', '>>', and '<<' direct to the BITWISE page, which doesn't mention any of them at all.)
msg193122 - (view) Author: Ron Adam (ron_adam) * Date: 2013-07-15 18:30
Patch update: "<>" removed from pydoc symbols table.
msg193123 - (view) Author: Ron Adam (ron_adam) * Date: 2013-07-15 18:34
I agree the specific content for each symbol are separate issues.  Those are probably best addressed individually or a few at a time when they are closely related.
msg200506 - (view) Author: Ron Adam (ron_adam) * Date: 2013-10-19 22:13
Adding you Nick, I don't have commit rights.  This probably doesn't need much.. maybe a one line comment in news is all.  (And maybe not even that.)
msg200539 - (view) Author: Nick Coghlan (ncoghlan) * (Python committer) Date: 2013-10-20 03:49
I'll take a closer look at this prior to beta 1.

In the meantime, Ron, I just noticed we don't have a Contributor Licensing Agreement in place for you. Given your past contributions, we should probably fix that :)

The form can be signed electronically these days: http://www.python.org/psf/contrib/contrib-form/
msg313040 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2018-02-27 23:58
It looks like this patch was close to being approved.  Ron, would you be able to open a Github pull request for your patch?  Thanks!
msg341743 - (view) Author: Sanyam Khurana (CuriousLearner) * (Python triager) Date: 2019-05-07 15:01
Hey Ron,

Friendly ping :)

Can you please convert this into a pull request?
History
Date User Action Args
2022-04-11 14:57:47adminsetgithub: 62587
2019-05-09 21:10:38CuriousLearnersetstage: patch review
pull_requests: + pull_request13135
2019-05-08 10:25:58SilentGhostsetversions: - Python 3.9
2019-05-07 15:01:48CuriousLearnersetnosy: + CuriousLearner

messages: + msg341743
versions: + Python 3.9
2018-02-27 23:58:15cheryl.sabellasetnosy: + cheryl.sabella

messages: + msg313040
versions: + Python 3.8, - Python 3.4
2013-10-20 03:49:14ncoghlansetmessages: + msg200539
2013-10-19 22:13:56ron_adamsetnosy: + ncoghlan
messages: + msg200506
2013-07-25 10:22:01ronaldoussorensetnosy: + ronaldoussoren
2013-07-15 18:34:32ron_adamsetmessages: + msg193123
2013-07-15 18:30:55ron_adamsetfiles: + pdoc_symbols.diff

messages: + msg193122
2013-07-15 18:29:20ron_adamsetfiles: - pdoc_symbols.diff
2013-07-15 16:14:05zach.waresettype: enhancement
messages: + msg193115
2013-07-15 04:36:43ron_adamsetmessages: + msg193074
2013-07-15 04:36:12ron_adamsetfiles: - pdoc_symbols.diff
2013-07-15 04:35:15ron_adamsetfiles: + pdoc_symbols.diff

messages: + msg193073
2013-07-14 17:47:34zach.waresetnosy: + zach.ware
messages: + msg193063
2013-07-07 13:10:53ron_adamsetfiles: + pdoc_symbols.diff

messages: + msg192552
2013-07-07 13:09:25ron_adamsetfiles: - pdoc_symbols.diff
2013-07-06 17:29:22ron_adamsettitle: Add 'symbols' link to html menu bar. -> Add 'symbols' link to pydoc's html menu bar.
2013-07-06 17:28:15ron_adamcreate