Skip to content

Commit

Permalink
Rename Related Components to Related Panes for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach committed Aug 9, 2022
1 parent 2ea66d9 commit d8bc4ed
Show file tree
Hide file tree
Showing 14 changed files with 41 additions and 41 deletions.
4 changes: 2 additions & 2 deletions STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Must (not), should (not), recommended, suggested, may, and can generally follow
* L2 Headings for section heads: Use ========= with overline; 3 blank lines before them
* L3 headings for subheads: Use ~~~~~~; 2 blank lines
* L4 Headings for sub-subheads if truly necessary: Use ---------; 1 blank line; keep to a minimum (consider a flatter structure or breaking into multiple files)
* Related components at the bottom: L2 heading; bullets; try for 2-4 links if included
* All files with Related components should contain at least one L2 section; if only one, can be entitled Overview
* Related panes at the bottom: L2 heading; bullets; try for 2-4 links if included
* All files with ``Related panes`` should contain at least one L2 section; if only one, can be entitled Overview
* Typically, for files with multiple sections or longer than one page, a summary section of a few lines length is helpful before the first section, summarizing the functionality discussed in the section and its purpose
* Name of component/topic should be in first sentence, Title Case, bold on first use

Expand Down
6 changes: 3 additions & 3 deletions doc/panes/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ To avoid showing plots while debugging, deactivate the :guilabel:`Process execut



==================
Related components
==================
=============
Related panes
=============

* :doc:`editor`
* :doc:`ipythonconsole`
Expand Down
6 changes: 3 additions & 3 deletions doc/panes/editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ Note that this only affects how the outline is displayed; it has no impact on th



==================
Related components
==================
=============
Related panes
=============

* :doc:`fileexplorer`
* :doc:`findinfiles`
Expand Down
6 changes: 3 additions & 3 deletions doc/panes/fileexplorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ Additionally, when you right-click a file, you will find an :guilabel:`Open with



==================
Related components
==================
=============
Related panes
=============

* :doc:`editor`
* :doc:`findinfiles`
Expand Down
6 changes: 3 additions & 3 deletions doc/panes/findinfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ Finally, to change the number of matches displayed, select the :guilabel:`Set ma



==================
Related components
==================
=============
Related panes
=============

* :doc:`editor`
* :doc:`fileexplorer`
6 changes: 3 additions & 3 deletions doc/panes/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ This can be disabled in the :guilabel:`Help` pane's top-right options menu so th



==================
Related components
==================
=============
Related panes
=============

* :doc:`editor`
* :doc:`ipythonconsole`
Expand Down
6 changes: 3 additions & 3 deletions doc/panes/historylog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ While there is currently no built-in way to clear history from the Spyder interf



==================
Related components
==================
=============
Related panes
=============

* :doc:`ipythonconsole`
6 changes: 3 additions & 3 deletions doc/panes/ipythonconsole.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,9 @@ If desired, you can turn it on or off, and prevent specific modules from being r



==================
Related components
==================
=============
Related panes
=============

* :doc:`debugging`
* :doc:`editor`
Expand Down
6 changes: 3 additions & 3 deletions doc/panes/onlinehelp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ To cancel searching or page loading, click the stop button (red square), and to



==================
Related components
==================
=============
Related panes
=============

* :doc:`help`
6 changes: 3 additions & 3 deletions doc/panes/plots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ Finally, you can use the "remove" and "remove all" buttons in the toolbar to cle



==================
Related components
==================
=============
Related panes
=============

* :doc:`ipythonconsole`
* :doc:`variableexplorer`
6 changes: 3 additions & 3 deletions doc/panes/profiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ For more information, go to the `spyder-memory-profiler git repository`_.



==================
Related components
==================
=============
Related panes
=============

* :doc:`ipythonconsole`
* :doc:`pylint`
6 changes: 3 additions & 3 deletions doc/panes/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ To use this functionality, the :guilabel:`Project` must be located in a ``git``



==================
Related components
==================
=============
Related panes
=============

* :doc:`editor`
* :doc:`fileexplorer`
6 changes: 3 additions & 3 deletions doc/panes/pylint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ For more details on configuring Pylint, see the `Pylint documentation`_.



==================
Related components
==================
=============
Related panes
=============

* :doc:`editor`
* :doc:`profiler`
6 changes: 3 additions & 3 deletions doc/panes/variableexplorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,9 @@ Finally, we added a context-menu action to open any object using the new Object



==================
Related components
==================
=============
Related panes
=============

* :doc:`debugging`
* :doc:`ipythonconsole`

0 comments on commit d8bc4ed

Please sign in to comment.