Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove unneeded extra underscore.
  • Loading branch information
terryjreedy committed Sep 21, 2020
commit 0308f80548ee65676ebff5a8a50f0df89dc8fe52
5 changes: 2 additions & 3 deletions Lib/idlelib/editor.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,6 @@ def set_line_and_column(self, event=None):
("help", "_Help"),
]


def createmenubar(self):
"""Populate the menu bar widget for the editor window.

Expand Down Expand Up @@ -944,12 +943,12 @@ def reset_help_menu_entries(self):
if help_list:
helpmenu.add_separator()
for entry in help_list:
cmd = self.__extra_help_callback(entry[1])
cmd = self._extra_help_callback(entry[1])
helpmenu.add_command(label=entry[0], command=cmd)
# And update the menu dictionary.
self.menudict['help'] = helpmenu

def __extra_help_callback(self, helpfile):
def _extra_help_callback(self, helpfile):
"""Create a callback with the helpfile value frozen at definition time.

Args:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This style of describing args in doc-strings is non-standard. I think it would be shorter and simpler to just remove the "Args:" heading, and change the "Returns:" section into a single line of text.

Likewise for other methods.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Cheryl did this PR after we refactored configdialog. For that, we had some exceptionally wordy docstrings to keep things clear. This docstring should start with 'Return...'

Expand Down