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

Consider adding warning to readme #65

Closed
RX14 opened this issue Oct 15, 2017 · 6 comments · Fixed by #66
Closed

Consider adding warning to readme #65

RX14 opened this issue Oct 15, 2017 · 6 comments · Fixed by #66

Comments

@RX14
Copy link

RX14 commented Oct 15, 2017

See: crystal-lang/crystal#5128

@oprypin
Copy link
Contributor

oprypin commented Oct 16, 2017

Heck, maybe add a warning at the start of each icr run

@greyblake
Copy link
Member

greyblake commented Oct 16, 2017

LOL :)
I thought we get this complaint much earlier.

Not everyone reads README carefully, so I am for adding the warnings to the icr so it prints it on every start.
The message should warn about the following:

  • Network operations
  • File operations
  • Random numbers
  • Time / Time.now
  • Anything else?

@martinos
Copy link

martinos commented Oct 16, 2017

In the current README the explanation is in the "How does it work?" section. Personally I skip reading such sections because when I start using a library I don't care that much about the implementation details.

I think that adding a big warning near the beginning of the README and/or when irc is launched would do it. This warning would tell the user that each time that a command is run, the program gets recompiled and rerun and its internal state will get lost and recalculated.

@greyblake, I think we could add Time.now to your list.

@greyblake
Copy link
Member

Maybe we can display the message when icr is running first time by the user?

@oprypin
Copy link
Contributor

oprypin commented Oct 16, 2017 via email

@RX14
Copy link
Author

RX14 commented Oct 16, 2017

Or do it like GNU parallel's citation notice: you run parallel --citation and it silences the message forever.

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

Successfully merging a pull request may close this issue.

4 participants