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

Eddiefiggie patch 1 #2914

Merged
merged 2 commits into from Oct 29, 2017
Merged

Eddiefiggie patch 1 #2914

merged 2 commits into from Oct 29, 2017

Conversation

@eddiefiggie
Copy link
Contributor

@eddiefiggie eddiefiggie commented Oct 29, 2017

Pull Request Checklist

  • I’ve read the guidelines for contributing.
  • I updated AUTHORS.txt and CHANGES.txt (if the change is non-trivial) and documentation (if applicable).
  • I tested my changes.

Description

When your environmental variable $EDITOR is not mapped, and you use the following command "nikola new_post -e", you currently get the following error message:

"$EDITOR not set, cannot edit the post. Please do it manually."

As a user, I was a little confused by this. The first sentence sent me searching for a Nikola setting where I can set the preferred editor. The second sentence had me contemplating if I needed to edit the "setting" within Nikola manually or the post I just made. These were first thoughts when I read the message.

I thought, perhaps, you might use this proposed message so to be a bit more explicit. I tried to keep the words to a minimum while still being as clear as possible.

"$EDITOR not set within the operating system, cannot edit the post with '-e'. Post must be altered manually."

I'm hopeful this might prove valuable to some users in the future.

eddiefiggie added 2 commits Oct 29, 2017
The original error, for the novice may not be as clear is it might others be.  At first glance it appears to be a setting change someone needs to make within Nikola versus the OS.  I believe this trivial adjustment is a bit more explicit.
I believe the proposed error message is a bit more explicit.  When I first encountered this error as a user I was a bit confused.   I wasn't sure, at first, if $EDITOR was a Nikola setting.  Also, the second sentence wasn't clear on what "must be done manually ($EDITOR or the post)."  Semantics granted, but those were my personal first impressions and thought this might help make it clearer.  Also, this is my first ever attempt at a pull request.  :)

So I changed this:
"$EDITOR not set, cannot edit the post.  Please do it manually."

With this:
"$EDITOR not set within the operating system, cannot edit the post with \'-e\'.  Post must be altered manually."
Copy link
Member

@Kwpolska Kwpolska left a comment

Good idea. I hope you don’t mind if I reword it a little bit?

@Kwpolska Kwpolska merged commit 4e405dc into getnikola:master Oct 29, 2017
3 checks passed
@Kwpolska
Copy link
Member

@Kwpolska Kwpolska commented Oct 29, 2017

@eddiefiggie
Copy link
Contributor Author

@eddiefiggie eddiefiggie commented Oct 29, 2017

Don’t mind at all. Appreciate the consideration. This is an excellent project. Absolutely love it.

@eddiefiggie eddiefiggie deleted the eddiefiggie-patch-1 branch Nov 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants