Skip to content

3 Issues with Commands Page #148

@vwheeler63

Description

@vwheeler63

Issue 1

With page https://docs.sublimetext.io/reference/commands.html when a command has a list after it, there is nothing that explains what this means or how to code it with the command. This should be at the top of the list.

Issue 2:

With the show_panel command here, the first list item is listed as "panel (Enum): Values: incremental_find, find, replace, find_in_files, console or output.<panel_name>." However, given the arrival of the Python enum module and it's various classes like IntEnum, listing this as an "Enum" type can be confusing. The show_panel command's panel argument is actually a String type and and needs to be one of a list of recognized strings. This should be clarified in the wording to help programmers get it right without having to experiment to figure it out, or spend time looking for an enumeration in the sublime.py file or elsewhere.

Issue 3:

The "output.<panel_name>" panel name as one show_panel name values that can be used with the "panel" argument is missing information. Shouldn't it be listed with what the possible values for <panel_name> can be? Here are ones that I discovered this by doing a Find in Files in all the Sublime Text Python source code that comes in the application + shipped packages, plus the default keymap file for Windows.

Core:

  • core.py
    • output.exec

Shipped Packages:

  • Diff::diff.py
    • output.unsaved_changes
    • output.diff_views
    • output.diff_files
  • ChannelRepositoryTools::tests.py
    • output.channel_repository_tools

which makes it appear that it is meant to be "output.<panel_name>" where <panel_name> might be user created? (i.e. by Package authors?). Anyway, it would be very helpful if this were clarified.

Thanks in advance.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions