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.

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

Clarify editor documentation for PATH variable and VS Code #1160

Merged
merged 1 commit into from
Jan 23, 2021

Conversation

micahellison
Copy link
Member

@micahellison micahellison commented Jan 23, 2021

Fixes #1155. There were VS code instructions for Mac and Linux, but not Windows. This unifies the instructions for all OSes since the --wait argument works the same everywhere.

The instructions were also needlessly complicated and revolved around the PATH variable, so I added a preamble paragraph to the editors section about using the PATH variable.

I also moved up the VS Code instructions since they're very similar to Sublime's, and I added a link to Sublime while I was in there.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have tested this code locally.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.
  • All tests pass.

@micahellison micahellison added the documentation Improvements or additions to documentation label Jan 23, 2021
@micahellison micahellison changed the title Clarify editor documentation Clarify editor documentation for PATH variable and VS Code Jan 23, 2021
Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

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

🧇

@wren wren merged commit 8979438 into jrnl-org:develop Jan 23, 2021
@micahellison micahellison deleted the docs-1155 branch January 23, 2021 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add instructions to add VSCode as an external editor for Windows
2 participants