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

Examples should be with placeholders #7

Open
singuerinc opened this issue Aug 16, 2016 · 3 comments
Open

Examples should be with placeholders #7

singuerinc opened this issue Aug 16, 2016 · 3 comments

Comments

@singuerinc
Copy link

Sometimes people just copy/paste examples/documentation.
Maybe is better to put a note or a placeholder.

Example:

$ git config --global user.signingkey [KEY-ID-HERE]
$ git config --global commit.gpgsign true
@pstadler
Copy link
Owner

I'm not sure whether this would make it more complicated.

@rogeruiz
Copy link

rogeruiz commented Feb 4, 2017

Why not just leverage environmental variables where it would be the most helpful, like long output, and have a setup script that simply exports them. That way the examples can just look like this.


Example:

$ # assuming you exported the variables from before…
$ git config --global user.signingkey $KEY_ID_HERE
$ git config --global commit.gpgsign true

@pstadler
Copy link
Owner

pstadler commented Feb 4, 2017

That would make more sense, PRs welcome.

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

No branches or pull requests

3 participants