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

What's the meaning behind the "[*] => $e*" part? #4

Open
creature opened this issue Aug 20, 2015 · 3 comments
Open

What's the meaning behind the "[*] => $e*" part? #4

creature opened this issue Aug 20, 2015 · 3 comments

Comments

@creature
Copy link
Contributor

When I run gst I see some output that looks like this:

On branch: feature-branch  |  [*] => $e*

What does the part after the pipe indicate? I thought that maybe my terminal was failing to expand a variable somewhere, but I can see this included in the screencast & example output in the readme too.

PS. Thanks for creating scmpuff - I find it super-useful. :)

@mroth
Copy link
Owner

mroth commented Aug 20, 2015

Ah, that's the "key" for the number output below, it indicates [1] will map to environment variable $e1, [2] => $e2, etc...

I agree it's really confusing. I inherited it when I was originally trying to make scmpuff an exact 1:1 interface map from scm_breeze -- but I don't have that feature requirement anymore. Is there another syntax you think might be more clear? Or maybe I should just drop that in the UI entirely.

@jeffbyrnes
Copy link

What about a slightly more explicit example?

E.g.,

[1] => $e1, [2] => $e2, [*] => $e*

@creature
Copy link
Contributor Author

creature commented Sep 1, 2015

Thanks; that makes sense.

Is there another syntax you think might be more clear? Or maybe I should just drop that in the UI entirely.

I'd consider using n or n instead of *, but that's only going to help make things clear for terminals that support italic/bold/coloured fonts. I also think it would be OK to remove it from the output of scmpuff_status, and mention it in the command's help text & the project readme.

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