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

Update docs to include time and title in arguments with --edit #1657

Merged
merged 1 commit into from
Jan 7, 2023

Conversation

pconrad-fb
Copy link
Contributor

@pconrad-fb pconrad-fb commented Jan 6, 2023

Fixes #1072.

The issue was that it wasn't clear how to specify a time when using an external editor.
I added a few notes based on the comment by @micahellison. Ultimately, it might make
sense to describe somewhere the fact that jrnl uses the first line to figure out the time/date,
no matter how you slice it, so that it's clear that you can just start typing Last week: or
whatever, even when you're in an external editor. For now, though, I think these added lines
in the external-editors.md file will help.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • 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. N/A I think

Copy link
Member

@micahellison micahellison left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I think this is a good spot for it, and each instruction flows into the next really nicely.

@micahellison micahellison added the documentation Improvements or additions to documentation label Jan 7, 2023
@micahellison micahellison changed the title Update external-editors.md Update docs to include time and title in arguments with --edit Jan 7, 2023
@micahellison micahellison merged commit 9547411 into jrnl-org:develop Jan 7, 2023
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.

Clarify difference between editor and cli entries in docs
2 participants