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

Needs better code documentation #1

Open
nashv opened this issue Jul 20, 2013 · 3 comments
Open

Needs better code documentation #1

nashv opened this issue Jul 20, 2013 · 3 comments

Comments

@nashv
Copy link

nashv commented Jul 20, 2013

I downloaded the code, in order to add password encryption using crypto.js, so that Platen could be my regular blog client. But the code is so much of a mess...It really needs better documentation.

@AlexTatiyants
Copy link
Owner

Documentation is not a bad idea, though I'm not sure when I'll have the time.

By the way, I'm afraid you've committed a bit of a netiquette foux pas. Calling someone else's code "so much of a mess" is rarely an effective way to get help from them. Please allow me to suggest an alternative approach:

You: "Hey man, great job on this tool, thanks a lot for writing it. Listen, I want to add password encryption but I'm having a bit of trouble figuring out where to do it. Could you help?"

Me: "Sure, all settings including the password are managed in the settings service (scripts/services/settings.js). There are two methods, load() and save() which could be modified to add password encryption. Hope this helps!"

You: "Great, thanks again!"

The difference is subtle, but surprisingly effective. Have a nice day!

@nashv
Copy link
Author

nashv commented Jul 22, 2013

Oh dear me, it's one of those sensitive ones who do not understand that an opinion provided to reveal a perceived lacuna is neither a personal insult nor a cry for help.

Have a nice day.

@AlexTatiyants
Copy link
Owner

My bad, I thought that your original comment was in fact asking for help. However, since you were simply sharing an opinion, it is completely justifiable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants