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

Add documentation about how the editor must be a blocking process #1456

Closed
4 tasks done
micahellison opened this issue Apr 23, 2022 · 0 comments · Fixed by #1624
Closed
4 tasks done

Add documentation about how the editor must be a blocking process #1456

micahellison opened this issue Apr 23, 2022 · 0 comments · Fixed by #1624
Assignees
Labels
documentation Improvements or additions to documentation 📌 This can't go stale ready for pr Okay to start work. Feel free to ask questions.

Comments

@micahellison
Copy link
Member

micahellison commented Apr 23, 2022

Documentation Change

Affected Page(s)

What Could Be Better?

When I saw #1451 about getting neovide to work in jrnl, I realized that it wasn't clear in the docs that the editor needs to be a blocking process, rather than returning control to jrnl immediately.

  • External Editors page

    • Before going into all the examples on how to make various editors into blocking processes, it should start by mentioning that this is required for any editor.
    • May be worth mentioning that many editors are blocking by default, such as vim.
    • The failure scenario for editing jrnl without a blocking editor is that jrnl just finishes running before you edit the entry. Mention that too, so people know what to look for.
  • Config reference page

    • It states that "jrnl processes the file once the editor is closed" which is only true if the editor is a blocking process. The text should change a bit to reflect that.
@micahellison micahellison added documentation Improvements or additions to documentation 🆕 New! labels Apr 23, 2022
@micahellison micahellison added 📌 This can't go stale and removed 🆕 New! labels Apr 30, 2022
@micahellison micahellison added the ready for pr Okay to start work. Feel free to ask questions. label Aug 13, 2022
@micahellison micahellison self-assigned this Oct 29, 2022
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 📌 This can't go stale ready for pr Okay to start work. Feel free to ask questions.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant