-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
MRG, DOC: update install instructions #7971
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.
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
Conversation
|
Looks very nice! Other than my tiny nitpick and one failing Azure job 👍 for merge. |
hoechenberger
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left two small comments, otherwise looks good to me
| @@ -1,4 +1,4 @@ | |||
| name: base | |||
| name: mne | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're going to need to update the CIs to reflect this change, we assume base in our azure-pipelines.yml at least
https://github.com/mne-tools/mne-python/blob/master/azure-pipelines.yml#L150
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The particular line you're linking to is in the notebook/server CI job, so it actually should stay the way it is. But there are other CI changes needed; working on them now.
|
Marking as backport-candidate. We don't need to make a release for this, but do need to at least push a commit to I did not look too deeply at the changes, happy to look once @cbrnr and @hoechenberger are happy (or if you need another opinion) |
|
Here's the rendered doc: https://20983-1301584-gh.circle-artifacts.com/0/dev/install/mne_python.html Marking as WIP because I had to remove |
doc/install/mne_python.rst
Outdated
| - `Visual Studio Code`_ (often shortened to "vscode") is a development-focused | ||
| text editor that supports many programming languages in addition to Python, | ||
| and has a rich ecosystem of packages to extend its capabilities. Installing | ||
| `Microsoft's Python Extension | ||
| includes an integrated terminal console, and has a rich ecosystem of packages | ||
| to extend its capabilities. Installing `Microsoft's Python Extension | ||
| <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`__ is | ||
| enough to get most Python users up and running. Visual Studio Code is free | ||
| and open-source. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had the idea to also add the "VS Code" abbreviation, WDYT?
- `Visual Studio Code`_ (often shortened to "VS Code" or "vscode") is a
development-focused text editor that supports many programming languages in
addition to Python, includes an integrated terminal console, and has a rich
ecosystem of packages to extend its capabilities. Installing
`Microsoft's Python Extension
<https://marketplace.visualstudio.com/items?itemName=ms-python.python>`__ is
enough to get most Python users up and running. Visual Studio Code is free
and open-source.
Also, one thing I'd love us to mention is the Pylance extension, even though it's still a preview version. It builds on the Python extension and for me, this thing was really a game changer: for the first time since I started using VS Code in Python, I feel that it's actually working properly, and is fun to use. It would make using Python so much better, even for newcomers:
Link to the extension:
https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance
Pylance announcement:
https://devblogs.microsoft.com/python/announcing-pylance-fast-feature-rich-language-support-for-python-in-visual-studio-code/#comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's just sad that VS Code still can't do proper Python indentation, e.g.:
x = [1, 2, 3,
4, 5, 6]Of course there's a dedicated extension, but this basic feature should really work out of the box. Other than that, VS Code is great, and so is PyCharm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's just sad that VS Code still can't do proper Python indentation, e.g.:
+1000
Other than that, VS Code is great, and so is PyCharm.
I still prefer PyCharm Professional to VS Code :) But VS Code is catching up, quick.
hoechenberger
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go from my end besides the comment I left.
|
Looks like using @hoechenberger I didn't end up adding the pylance info, since I personally don't feel comfortable recommending it because (1) I haven't actually tested it, and (2) it's closed source and they don't plan to change that. LMK if including pylance is a blocker for you; if so I can find a way to mention it without endorsing explicitly. |
|
So far |
|
Ok for me to merge as-is! |
|
Thanks @drammock! |
closes #7945