Configure ide #11615

th3linja · 2023-03-31T16:37:53Z

Reference issue

What does this implement/fix?

Creating a page that steps through the various IDE settings that are helpful when contributing to MNE-Python.

Additional information

Picking up and resolving an idle ticket. Tried implementing some of the changes as suggested. Not sure if :menuselection: by Sphinx is working as rst is not displaying correctly for me when installing MNE right out of the box. May require additional setup to view it correctly.

**Fixed duplicate label

larsoner · 2023-03-31T17:10:11Z

@th3linja you don't need to open a new PR for each new change, just push commits to your branch and they should show up on GitHub. cc @britta-wstnr this is why #11613 was closed I think

th3linja · 2023-03-31T18:13:12Z

@larsoner Sorry, I accidentally made a conflict when playing around with the code and couldn't find a way to revert it so I had to start anew.

doc/install/configure_ide.rst

britta-wstnr

I added some changes to the text - @th3linja you can accept those changes right here on GitHub if you want (then you'd have to pull the changes to your local copy via git).

As mentioned in a comment to @mscheltienne's review: I wonder if the how to's for the different IDE's will be very hard to keep up-to-date. Things will be moved around in the Settings, I assume, and then we'd have to remember our list and compare periodically. Maybe we could only keep the list of things that is good to add to any IDE, but not mention how this should be done?
Thoughts?

britta-wstnr · 2023-04-03T08:27:26Z

doc/install/configure_ide.rst

+Thanks for taking the time to contribute! This guide steps through various IDE settings that are helpful when
+contributing to MNE-Python.


Suggested change

Thanks for taking the time to contribute! This guide steps through various IDE settings that are helpful when

contributing to MNE-Python.

This guide steps through various IDE settings that are helpful when contributing to MNE-Python.

Given that this will land somewhere within the contributor's guide, I don't think we will need to add the thank you again.

britta-wstnr · 2023-04-03T08:28:28Z

doc/install/configure_ide.rst

+
+Some of the basic settings include enabling linting, setting line margins, introspection, and docstring type:
+
+* Linting - is the automated checking of your source code for programmatic and stylistic errors. Most of the time basic linting is already enabled but let's double check.


Suggested change

* Linting - is the automated checking of your source code for programmatic and stylistic errors. Most of the time basic linting is already enabled but let's double check.

* Linting is the automated checking of your source code for programmatic and stylistic errors. Most of the time, basic linting is already enabled but it is a good idea to double check.

britta-wstnr · 2023-04-03T08:29:39Z

doc/install/configure_ide.rst

+
+* Line margins - we have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders adhere to that rule.
+
+* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building


Suggested change

* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building

* Introspection helps by removing trailing whitespaces that can be problematic when compiling or building.

britta-wstnr · 2023-04-03T08:30:45Z

doc/install/configure_ide.rst

+* Line margins - we have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders adhere to that rule.
+
+* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building
+
+* Docstring - we use NumPy because it supports a combination of reStructured and GoogleDocstrings and supported by Sphinx


Suggested change

* Line margins - we have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders adhere to that rule.

* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building

* Docstring - we use NumPy because it supports a combination of reStructured and GoogleDocstrings and supported by Sphinx

* Line margins - we have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders adhere to that rule.

* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building

* Docstring - we use NumPy because it supports a combination of reStructured and GoogleDocstrings and is supported by Sphinx

I think this bullet point also could have a bit more information.

(the last one on "Docstring" that is - just seeing now GitHub shows the previous ones in the view here too 🙃 )

Thanks! Will get to it as soon as I can.

hoechenberger · 2023-04-03T21:16:44Z

doc/install/configure_ide.rst

+------
+
+* :menuselection:`Command Palette (Ctrl + Shift + P) --> Lint --> Python: Enable/Disable Linting (click on Enable)`
+* :menuselection:`Use ``python.autoComplete.preloadModules": ["numpy", "pandas", "matplotlib", "mne"]```


Is this really still a thing with Pylance?

I'm just continuing off from the work that was left unattended for a while. Not sure what versioning was in place when the instructions were last created. Let me know if there needs to be a change.

… into configure_ide2

th3linja · 2023-04-04T05:54:25Z

I've made some changes to reflect the suggestions made. Let me know what you think. Also if someone using VSCode could double down on the steps with their IDE version, that would be great.

britta-wstnr · 2023-04-04T06:08:41Z

Given @hoechenberger's latest comment and before we venture further, can I raise the point again that I raised above and that @mscheltienne seemed to agree with?
I think giving such specific settings for IDEs will be very hard to keep up-to-date - so, do we want to do that? Or do we want to keep this more general, i.e. mention what settings are useful but not give directions on how to set them in different IDE's.

Pinging @larsoner @hoechenberger and @drammock who opened the original issue.

drammock · 2023-04-04T14:38:14Z

mention what settings are useful but not give directions on how to set them in different IDE's

+1. I imagine something like this would be more future-proof:

With the right configuration, using an Integrated Development Environment (IDE) can make contributing to MNE-Python much easier.
This page describes the most common IDE settings that are recommended for MNE-Python contributors.

## syntax highlighting
<most users find it helpful, usually enabled by default, if not search "python syntax highlight [name of IDE]" to learn how to do it.>

## Linting
<describe what linting is, mention what linter we use.>

### Rulers
<describe what & why of rulers>

### Line endings and whitespace
<4 spaces (not tabs), LF not CRLF (also mention relevant git setting), trailing whitespace,
 trailing newlines at EOF, whitespace around classes/functions/methods, whitespace in docstrings.>

### code completion / introspection
<what & how; should probably mention at least jedi and pylance>

## Configuring Specific IDEs

### Spyder
<general comments about which config sections to look in for things (tools -> preferences -> { completion and linting | source code | advanced settings } ) but don't try to say exactly what is found where.>

### VSCode
<which extensions should be installed, general comments about how to configure this IDE (GUI dialog vs config JSON file)>

### Pycharm
<similar advice to Spyder / VSCode>

britta-wstnr · 2023-04-14T16:16:41Z

Hi @th3linja, I agree with @drammock's suggestion to update this - are you able to work on this? 🙂

th3linja · 2023-04-14T16:26:00Z

For sure! I'll send an update as soon as I get the chance.

th3linja · 2023-04-23T22:27:16Z

Hi all, I made some revisions. Let me know how it looks!

mscheltienne · 2023-06-29T10:06:55Z

doc/install/configure_ide.rst

+
+Rulers
+^^^^^^
+We have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders


Suggested change

We have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders

We have code style rules that forbid lines longer than 88 characters, so having a ruler at 88 characters helps coders

I would mention that MNE uses black for enforcing a code style.

mscheltienne · 2023-06-29T10:07:05Z

doc/install/configure_ide.rst

+Syntax Highlighting
+^^^^^^^^^^^^^^^^^^^
+Syntax highlighting is a feature that determines the color and style of source code displayed in the IDE. Most users
+find it helpful and is usually enabled by default. If not, search "python syntax highlight [name of IDE]" to learn how


Suggested change

find it helpful and is usually enabled by default. If not, search "python syntax highlight [name of IDE]" to learn how

find it helpful and it is usually enabled by default. If not, search "python syntax highlight [name of IDE]" to learn how

mscheltienne · 2023-06-29T10:55:09Z

doc/install/configure_ide.rst

+Linting
+^^^^^^^
+Linting is the automated checking of your source code for programmatic and stylistic errors. Most of the time, basic
+linting is already enabled but it is a good idea to double-check. Search "python [name of IDE] linting" to learn how to
+configure it.


I would mention black here.

mscheltienne · 2023-06-29T10:56:26Z

doc/install/configure_ide.rst

+.. note:: The IDE configurations recommended below are not catered towards specified versions of the IDE, but rather a
+    general guide of where these settings may be found regardless of versioning.
+


I would remove this now that there are no details below.

wmvanvliet · 2023-11-16T08:03:55Z

Should I add Vim to this list or would that be overly archaic?

th3linja added 5 commits March 30, 2023 11:24

DOC: adds ide configuration guide under install

de3d691

DOC: adds ide configuration guide under install

bc0bc42

DOC: adds ide configuration guide under install

a72ef3c

Merge branch 'main' into configure_ide2

dd61b79

Merge remote-tracking branch 'upstream/main' into configure_ide2

32bc509

larsoner added this to the 1.4 milestone Mar 31, 2023

mscheltienne reviewed Apr 3, 2023

View reviewed changes

doc/install/configure_ide.rst Outdated Show resolved Hide resolved

britta-wstnr reviewed Apr 3, 2023

View reviewed changes

hoechenberger reviewed Apr 3, 2023

View reviewed changes

th3linja added 2 commits April 3, 2023 22:49

DOC: adds ide configuration guide under install

e648595

Merge branch 'configure_ide2' of https://github.com/th3linja/mne-python…

64f1bea

… into configure_ide2

DOC: adds ide configuration guide under install

1f9226f

britta-wstnr mentioned this pull request Apr 12, 2023

Update contributing guide #11609

Open

larsoner modified the milestones: 1.4, 1.5 Apr 21, 2023

revise ide configuration guide under install

968338b

mscheltienne reviewed Jun 29, 2023

View reviewed changes

larsoner modified the milestones: 1.5, 1.6 Jul 31, 2023

larsoner modified the milestones: 1.6, 1.7 Nov 16, 2023

larsoner modified the milestones: 1.7, 1.8 Apr 9, 2024

larsoner modified the milestones: 1.8, 1.9 Jul 15, 2024

larsoner mentioned this pull request Jul 15, 2024

DOC: Update install docs for Spyder #12716

Merged

larsoner modified the milestones: 1.9, 1.10 Dec 9, 2024

larsoner modified the milestones: 1.10, 1.11 Jun 26, 2025

		Thanks for taking the time to contribute! This guide steps through various IDE settings that are helpful when
		contributing to MNE-Python.

	Thanks for taking the time to contribute! This guide steps through various IDE settings that are helpful when
	contributing to MNE-Python.
	This guide steps through various IDE settings that are helpful when contributing to MNE-Python.


		Some of the basic settings include enabling linting, setting line margins, introspection, and docstring type:

		* Linting - is the automated checking of your source code for programmatic and stylistic errors. Most of the time basic linting is already enabled but let's double check.

	* Linting - is the automated checking of your source code for programmatic and stylistic errors. Most of the time basic linting is already enabled but let's double check.
	* Linting is the automated checking of your source code for programmatic and stylistic errors. Most of the time, basic linting is already enabled but it is a good idea to double check.


		* Line margins - we have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders adhere to that rule.

		* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building

	* Introspection - this helps removes trailing whitespaces that could be problematic when compiling or building
	* Introspection helps by removing trailing whitespaces that can be problematic when compiling or building.

	We have code style rules that forbid lines longer than 79 characters, so having a ruler at 79 characters helps coders
	We have code style rules that forbid lines longer than 88 characters, so having a ruler at 88 characters helps coders

	find it helpful and is usually enabled by default. If not, search "python syntax highlight [name of IDE]" to learn how
	find it helpful and it is usually enabled by default. If not, search "python syntax highlight [name of IDE]" to learn how

		.. note:: The IDE configurations recommended below are not catered towards specified versions of the IDE, but rather a
		general guide of where these settings may be found regardless of versioning.

Uh oh!

Configure ide #11615

Are you sure you want to change the base?

Configure ide #11615

Conversation

th3linja commented Mar 31, 2023

Reference issue

What does this implement/fix?

Additional information

Uh oh!

larsoner commented Mar 31, 2023

Uh oh!

th3linja commented Mar 31, 2023

Uh oh!

Uh oh!

britta-wstnr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

th3linja commented Apr 4, 2023

Uh oh!

britta-wstnr commented Apr 4, 2023

Uh oh!

drammock commented Apr 4, 2023

Uh oh!

britta-wstnr commented Apr 14, 2023

Uh oh!

th3linja commented Apr 14, 2023

Uh oh!

th3linja commented Apr 23, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wmvanvliet commented Nov 16, 2023

Uh oh!