[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Terry J. Reedy]

Change by Terry J. Reedy :


--
versions: +Python 3.10 -Python 2.7, 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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Zackery Spytz]

Change by Zackery Spytz :


--
nosy: +ZackerySpytz
nosy_count: 5.0 -> 6.0
pull_requests: +20281
pull_request: https://github.com/python/cpython/pull/21118

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

Few new options were added: see issue34189.

--

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Noah Haasis]

Noah Haasis  added the comment:

This are all the classes where the keywords are missing in the docs and their 
missing keywords:
TopLevel
['padx', 'pady']

Checkbutton
['compound', 'offrelief', 'overrelief', 'tristateimage', 'tristatevalue']

Entry
['disabledbackground', 'disabledforeground', 'readonlybackground']

Frame
['padx', 'pady']

Label
['compound']

Radiobutton
['compound', 'offrelief', 'overrelief', 'tristateimage', 'tristatevalue']

Text
['blockcursor', 'endline', 'inactiveselectbackground', 'insertunfocussed', 
'startline', 'tabstyle']

Spinbox
['validatecommand', 'values']

Menubutton
['activebackground', 'activeforeground', 'anchor', 'background', 'bitmap', 
'borderwidth', 'compound', 'cursor', 'direction', 'disabledforeground', 'font', 
'foreground', 'height', 'highlightbackground', 'highlightcolor', 
'highlightthickness', 'image', 'indicatoron', 'justify', 'menu', 'padx', 
'pady', 'relief', 'state', 'takefocus', 'text', 'textvariable', 'underline', 
'width', 'wraplength']

Message
['anchor', 'aspect', 'background', 'borderwidth', 'cursor', 'font', 
'foreground', 'highlightbackground', 'highlightcolor', 'highlightthickness', 
'justify', 'padx', 'pady', 'relief', 'takefocus', 'text', 'textvariable', 
'width']

The missing keywords appear in the OPTIONS list in the test but not in the 
docstring.

--

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Noah Haasis]

Change by Noah Haasis :


--
keywords: +patch
pull_requests: +7909
stage: needs patch -> patch review

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Noah Haasis]

Noah Haasis  added the comment:

This is a list of all valid keywordarguments of Listbox.__init__() listed in 
the test file: 
'activestyle', 'background', 'borderwidth', 'cursor',
'disabledforeground', 'exportselection',
'font', 'foreground', 'height',
'highlightbackground', 'highlightcolor', 'highlightthickness',
'listvariable', 'relief',
'selectbackground', 'selectborderwidth', 'selectforeground',
'selectmode', 'setgrid', 'state',
'takefocus', 'width', 'xscrollcommand', 'yscrollcommand'

The ones that are missing in the doc string:
'activestyle', 'disabledforeground', 
'listvariable','state'

--

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

The official Tk documentation is not always correct. OPTIONS attributes in 
tests should contain full lists of supported options, and running tests 
produces warnings for missed options, like: ListboxTest.OPTIONS doesn't contain 
"justify".

--

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Creation Elemental]

Creation Elemental  added the comment:

Ah, yes. That is what I meant to say. The doc string printed by help(widget)

--

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Terry J. Reedy]

Terry J. Reedy  added the comment:

By documentation, you mean the doc string for each widget, which is the basis 
for the help(widget) response.  I checked that there do not seem to be any 
other issues open for the docstrings.  Go ahead.  Use 
https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm as the reference.

C.E.: if you have a list of missing thing, can you post?  This is normal 
priority.

--
assignee:  -> docs@python
components: +Documentation
nosy: +docs@python, serhiy.storchaka, terry.reedy
stage:  -> needs patch
type:  -> behavior
versions: +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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Noah Haasis]

Noah Haasis  added the comment:

I'd like to work on this, if it's ok for everybody.

--
nosy: +noah.haasis

___
Python tracker 

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

[issue34154] Tkinter __init__ documentations sometimes missing valid keyword values

[Creation Elemental]

New submission from Creation Elemental :

Priority: Low
Type: Documentation issue

Some of the Tkinter documentation is incomplete. I've only checked it on the 
Listbox so far, but some of the valid keyword arguments are missing. The one I 
noticed was "disabledforeground" which changes how the foreground color of text 
when the Listbox is in the disabled state or has a selection mode of none. I've 
noticed this across multiple versions of python, including Python 2.7 and 
Python 3.6, both of which accepted "disabledforeground" as a valid keyword 
without it being in the list shown in the help for Listbox.__init__

I found the disabledforeground keyword argument when looking at the Listbox 
documentation here: https://www.tcl.tk/man/tcl8.4/TkCmd/listbox.htm

--
components: Tkinter
messages: 321921
nosy: Creation Elemental
priority: normal
severity: normal
status: open
title: Tkinter __init__ documentations sometimes missing valid keyword values
versions: Python 2.7, Python 3.6

___
Python tracker 

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