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

Cryptol REPL should say how to get help when it starts #617

Closed
brianhuffman opened this issue Jun 24, 2019 · 3 comments
Closed

Cryptol REPL should say how to get help when it starts #617

brianhuffman opened this issue Jun 24, 2019 · 3 comments
Labels
low-hanging fruit For issues that should be easy to fix
Milestone

Comments

@brianhuffman
Copy link
Contributor

When you start ghci, it tells noobs how to get help:

GHCi, version 8.6.5: http://www.haskell.org/ghc/  :? for help

But cryptol doesn't give any such hints:

┏━╸┏━┓╻ ╻┏━┓╺┳╸┏━┓╻
┃  ┣┳┛┗┳┛┣━┛ ┃ ┃ ┃┃
┗━╸╹┗╸ ╹ ╹   ╹ ┗━┛┗━╸
version 2.7.1 (ede8c3f, modified)

Loading module Cryptol
Cryptol>

I'm thinking about the times I've accidentally started vim, couldn't figure out how to quit the program, and then had to open another terminal to kill the process.

Maybe we should add a hint to the startup message about typing :? for help.

@brianhuffman brianhuffman added the low-hanging fruit For issues that should be easy to fix label Jun 24, 2019
@brianhuffman
Copy link
Contributor Author

Time for bike-shedding! Should we just add the help hint to the version line, like this:

┏━╸┏━┓╻ ╻┏━┓╺┳╸┏━┓╻
┃  ┣┳┛┗┳┛┣━┛ ┃ ┃ ┃┃
┗━╸╹┗╸ ╹ ╹   ╹ ┗━┛┗━╸
version 2.7.1 (ede8c3f) :? for help

Loading module Cryptol
Cryptol>

or put an additional line with a URL and the help hint like this:

┏━╸┏━┓╻ ╻┏━┓╺┳╸┏━┓╻
┃  ┣┳┛┗┳┛┣━┛ ┃ ┃ ┃┃
┗━╸╹┗╸ ╹ ╹   ╹ ┗━┛┗━╸
version 2.7.1 (ede8c3f)
https://cryptol.net  :? for help

Loading module Cryptol
Cryptol>

or maybe something else entirely?

@atomb atomb added this to the 2.8.0 milestone Aug 1, 2019
@atomb atomb modified the milestones: 2.8.0, 2.9.0 Sep 3, 2019
@atomb
Copy link
Contributor

atomb commented Nov 5, 2019

My favorite is your second example above, @brianhuffman.

@brianhuffman
Copy link
Contributor Author

Fixed by #657 (revision dd6d8d2).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low-hanging fruit For issues that should be easy to fix
Projects
None yet
Development

No branches or pull requests

2 participants