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.

Sign up for GitHub

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

Improve Files section #364

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve Files section #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions doc/panes/fileexplorer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Options menu
The options menu in the top right of the :guilabel:`Files` pane offers several ways to customize how your files are displayed.

By default, the pane displays the contents of your working directory without filtering.
However, it can filter the list to show only files matching the patterns set under :guilabel:`Show filenames with these extensions...`, if you toggle the :guilabel:`Filter filenames` button in the pane toolbar.
However, it can filter the list to show only files matching the patterns set under :guilabel:`Edit filter settings...`, if you toggle the :guilabel:`Filter filenames` button in the pane toolbar.

.. image:: /images/files/files-filters.gif
:alt: Spyder Files pane showing filtering files
Expand All @@ -81,7 +81,7 @@ File associations
=================

:guilabel:`Files` allows you to associate different external applications with specific file extensions they can open.
Under the :guilabel:`File associations` tab of the :guilabel:`Files` preferences pane, you can add file types and set the external program used to open each of them by default.
Under the :guilabel:`Preferences --> File associations` tab of the :guilabel:`Files` preferences pane, you can add file types and set the external program used to open each of them by default.
Copy link
Member

@CAM-Gerlach CAM-Gerlach Apr 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I'm unclear on the motivation for this change was made, since it implies two conflicting potential interpretations, neither of which is correct (unlike the previous text):

  • As mentioned, the existing text already states that this is the File associations tab of the Files preferences pane, so its confusing why "Preferences" is repeated again here
  • On first reading, this change implies that File associations is a pane underneath preferences, but that's not the case as mentioned
  • Furthermore, in context as written, it alternatively implies there is a Preferences in the Files preferences pane (and underneath that a File associations tab), but that is of course not correct either
  • Additionally, :guilabel: is for single, specific GUI labels; to support multiple levels of things you'd need :menuselection:

Without more context on the desired intent here, I can propose either a revert to the existing, correct text which explicitly specifies that this is a tab of a specific pane under preferences:

Suggested change
Under the :guilabel:`Preferences --> File associations` tab of the :guilabel:`Files` preferences pane, you can add file types and set the external program used to open each of them by default.
Under the :guilabel:`File associations` tab of the :guilabel:`Files` preferences pane, you can add file types and set the external program used to open each of them by default.

Or, we could specify the complete path all in one go, which is more direct and concise but lacks explicit cues for the reader as to what they should be looking for at each level, and also runs into the issue you raised in #365 which will take some engineering work to solve, and is de-facto gated by the implementation of the new theme, so I don't recommend this for now:

Suggested change
Under the :guilabel:`Preferences --> File associations` tab of the :guilabel:`Files` preferences pane, you can add file types and set the external program used to open each of them by default.
Under :menuselection:`Preferences --> Files --> File associations`, you can add file types and set the external program used to open each of them by default.

If you could help me understand better the problem this is intended to solve, I could try to help propose a better solution. Thanks!


.. image:: /images/files/files-associations.gif
:alt: Spyder Files pane showing files associations
Expand Down
Loading