Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup & Usage documentation for pydoc, IDLE, & 2to3 #59149

Open
ncoghlan opened this issue May 29, 2012 · 8 comments
Open

Setup & Usage documentation for pydoc, IDLE, & 2to3 #59149

ncoghlan opened this issue May 29, 2012 · 8 comments
Labels
docs Documentation in the Doc dir expert-IDLE type-feature A feature request or enhancement

Comments

@ncoghlan
Copy link
Contributor

ncoghlan commented May 29, 2012

BPO 14944
Nosy @terryjreedy, @ncoghlan, @ned-deily

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 2012-05-29.01:47:37.405>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Setup & Usage documentation for pydoc, IDLE, & 2to3'
updated_at = <Date 2019-03-20.17:15:04.841>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2019-03-20.17:15:04.841>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2012-05-29.01:47:37.405>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 14944
keywords = []
message_count = 8.0
messages = ['161831', '161836', '161843', '161844', '161845', '225118', '296381', '338499']
nosy_count = 6.0
nosy_names = ['terry.reedy', 'ncoghlan', 'ned.deily', 'docs@python', 'tshepang', 'Al.Sweigart']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue14944'
versions = ['Python 2.7', 'Python 3.7', 'Python 3.8']

@ncoghlan
Copy link
Contributor Author

ncoghlan commented May 29, 2012

pydoc is installed as a script by Python. It should be documented under http://docs.python.org/dev/using/index.html.

@ncoghlan ncoghlan added docs Documentation in the Doc dir type-feature A feature request or enhancement labels May 29, 2012
@ncoghlan
Copy link
Contributor Author

ncoghlan commented May 29, 2012

Same goes for idle and 2to3. These may just be cross-references to the relevant module documentation rather than completely new text.

@ncoghlan ncoghlan changed the title Setup & Usage documentation for pydoc Setup & Usage documentation for pydoc, idle & 2to3 May 29, 2012
@terryjreedy
Copy link
Member

terryjreedy commented May 29, 2012

I second the motion for IDLE. There is no module doc for it.

Off the top of my head, there should be a general section that

  • says what it is, and that it depends on tcl/tk and tkinter install;
  • mentions the existent of the menu Help / IDLE help document;
  • gives common startup methods from command line (I forget this) or inside interpreter ('from idlelib import idle') and that one may need to use one of these to see tracebacks if Idle crashes - even if one normally uses a system-specific method to directly run as gui app.
  • gives other common info and trouble-shooting tips (some of this is on tracker - such as deleting user .cfg that prevents startup).
  • points to system specific discussions, where ever they are put.

Then for each system,

  • tcl/tk situation
  • how to directly start up
  • location of config files

Windows: (what I use)
tcl/tk comes with system.
...

*nix:
tcl/tk probably already on system
...

mac: (ned daily)
special tcl/tk issues, special page on site
...

@ned-deily
Copy link
Member

ned-deily commented May 29, 2012

http://docs.python.org/py3k/library/idle.html (duplicates much of the IDLE help file)

@terryjreedy
Copy link
Member

terryjreedy commented May 29, 2012

Hmm, how did I miss that?? Well better to reference that, and maybe revise it. I believe there may also be another .txt document in idlelib.

Anyway, perhaps there should first be a section on tkinter by itself, and how to get the tcl/tk it depends on. Mention that optional part of Windows install, so tkinter will likely not work if unselected from installer.

@BreamoreBoy
Copy link
Mannequin

BreamoreBoy mannequin commented Aug 9, 2014

I'm assuming that this still applies to 3.4 and 2.7.

@terryjreedy
Copy link
Member

terryjreedy commented Jun 19, 2017

I am not sure where installed scripts are documented in Using Python. 'idle' and 'idle3' are not installed on Windows.

@terryjreedy terryjreedy changed the title Setup & Usage documentation for pydoc, idle & 2to3 Setup & Usage documentation for pydoc, IDLE, & 2to3 Jun 19, 2017
@terryjreedy
Copy link
Member

terryjreedy commented Mar 20, 2019

idle.html, derived from idle.rst, is now the IDLE help file.

pip also has pip3 command; perhaps ensurepip should be mentioned.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir expert-IDLE type-feature A feature request or enhancement
Projects
Status: No status
Development

No branches or pull requests

4 participants