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

better docs #383

Merged
merged 2 commits into from
Oct 6, 2017
Merged

better docs #383

merged 2 commits into from
Oct 6, 2017

Conversation

Zamiell
Copy link
Contributor

@Zamiell Zamiell commented Oct 5, 2017

No description provided.

@Zamiell
Copy link
Contributor Author

Zamiell commented Oct 5, 2017

erm, the above/below comments are meant to be seen inline on the commit, I guess those don't transfer over when you do a PR

@dominikschulz dominikschulz self-requested a review October 6, 2017 11:21
@dominikschulz dominikschulz added this to the 1.5.0 - Wizards milestone Oct 6, 2017
Copy link
Member

@dominikschulz dominikschulz left a comment

Choose a reason for hiding this comment

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

This is amazing. Those changes really beef up the docs.
Thank you very much!

@dominikschulz dominikschulz merged commit 311c0d8 into gopasspw:master Oct 6, 2017
@Zamiell
Copy link
Contributor Author

Zamiell commented Oct 6, 2017

I was thinking of doing a second PR. Two questions:

  1. There is no consistent line wrapping standard throughout the documentation. I propose there should either be no line wrapping at all, or there should be an 80 character limit. See this discussion. Which is it? I personally feel more comfortable with no wrapping, but either way, I can fix it.
  2. There is no consistent stylization of the word gopass throughout the documentation. Sometimes it is stylized as gopass and other times it is stylized as gopass. Which is it? I think it actually reduces clarity to always stylize it as the latter, as it can cause confusion as to whether the docs are talking about the program or instructing the user to execute the gopass command.

@dominikschulz
Copy link
Member

Please do so! That would be very welcome.

  1. Personally I also avoid line wrapping and rely on my editor to do that. No hard feelings though. If anyone comes up with a case for line wrapping that'd be also OK for me.
  2. I've tried to style it as gopass, but again: no strict preference from my side, I'd be fine with styling it as plain gopass if you prefer that and reserve the gopass styling for verbatim commands.

kpitt pushed a commit to kpitt/gopass that referenced this pull request Jul 21, 2022
* spent some hours giving some care to the docs

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

Successfully merging this pull request may close these issues.

3 participants