go-cmd / cmd

Non-blocking external commands in Go with streaming output

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pseduo code in README

hanneslehmann opened this issue · comments

There are some issues in your README - example, which prevents users to copy and paste it to test.

Mainly:

status := c.Status() -> c never declared. 
finalStatus -> never used

and main function missing. Wouldn't it be better to show off a running code snippet instead of a pseudo code?

Thank you @hanneslehmann for raising this issue.

You're right it was a problem with the pseudo code in the Readme.

I have fixed the "c" variable and the "main" function.

For the "finalStatus" I'm not updating the code, because it's added in there just to point out that you can use it in that context, so it's OK.