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

Pseduo code in README #27

Closed
hanneslehmann opened this issue Dec 11, 2018 · 1 comment
Closed

Pseduo code in README #27

hanneslehmann opened this issue Dec 11, 2018 · 1 comment

Comments

@hanneslehmann
Copy link

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?

@croqaz
Copy link
Member

croqaz commented Jul 15, 2019

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.

@croqaz croqaz closed this as completed Jul 15, 2019
This issue was closed.
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