Skip to content

Created Draft configure_ide.rst #10104

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

Jump to bottom
Draft
rkalahasty wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Created Draft configure_ide.rst #10104

rkalahasty wants to merge 2 commits into from

Conversation

@rkalahasty
Copy link

@rkalahasty rkalahasty commented Dec 7, 2021 •
edited
Loading

Reference issue

Fixes #9112

What does this implement/fix?

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

@rkalahasty rkalahasty changed the title Created Draft PR Created Draft configure_ide.rst Dec 7, 2021
@rkalahasty
Update configure_ide.rst
71f0db2 
Tutorials for how to make some basic IDE changes for Spyder, PyCharm, VsCode
@rkalahasty
Copy link
Author

rkalahasty commented Dec 7, 2021

@drammock

What do you think of the current format? I added everything mentioned in the original Issue and removing trailing whitespace? Thank you for your help.

@drammock
Copy link
Member

drammock commented Dec 7, 2021

This is a good start! Here are the errors from the CircleCI testing server, which automatically tries to build our documentation including the changes in this PR:

/home/circleci/project/doc/install/configure_ide.rst:4: WARNING: Title underline too short.

IDE Configuration Guide
==================
/home/circleci/project/doc/install/configure_ide.rst:13: WARNING: Line block ends without a blank line.
/home/circleci/project/doc/install/configure_ide.rst:18: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/circleci/project/doc/install/configure_ide.rst:19: WARNING: Line block ends without a blank line.
/home/circleci/project/doc/install/configure_ide.rst:24: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/circleci/project/doc/install/configure_ide.rst:25: WARNING: Line block ends without a blank line.
/home/circleci/project/doc/install/contributing.rst:4: WARNING: duplicate label contributing, other instance in /home/circleci/project/doc/install/configure_ide.rst
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/circleci/project/doc/install/configure_ide.rst: WARNING: document isn't included in any toctre

the numbers following each file path are line numbers, so you can tell which line of your source file is generating each warning. Try to fix those, and then before you push your changes, try building the docs locally (see our contributing page for guidance if you've never built our docs locally before). Ideally you get a successful local docs build that you can view in your browser to see how it looks, which might lead you to make more changes to the new page before pushing.

A few other comments that are clear to me just from looking at the source:

  1. sphinx has a menuselection role that we should use here to make the formatting nicer.
  2. rather than bolding the name of each editor, make each one its own subsection.
  3. This page should explain terms like "linting" and "introspection" so that users know what they're doing / don't have to blindly change things and trust us that it's a good idea. Also it should explain why we recommend these settings (e.g., 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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@larsoner larsoner Awaiting requested review from larsoner larsoner will be requested when the pull request is marked ready for review larsoner is a code owner

@drammock drammock Awaiting requested review from drammock drammock will be requested when the pull request is marked ready for review drammock is a code owner

@agramfort agramfort Awaiting requested review from agramfort agramfort will be requested when the pull request is marked ready for review agramfort is a code owner

@dengemann dengemann Awaiting requested review from dengemann dengemann will be requested when the pull request is marked ready for review dengemann is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ENH: IDE configuration docs

2 participants

@rkalahasty @drammock