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

Decouple HELP from std #118

Open
jmmv opened this issue Oct 28, 2021 · 0 comments
Open

Decouple HELP from std #118

jmmv opened this issue Oct 28, 2021 · 0 comments
Labels
refactoring Internal changes that are not user visible enhancements

Comments

@jmmv
Copy link
Collaborator

jmmv commented Oct 28, 2021

The HELP command is purely a feature of the REPL so it should be in the repl crate, not std.

Moving the command should be easy to do, except maybe for its tests that rely on the std MachineTester.

The more interesting question is: what do we do about the descriptions attached to all commands and functions? Somehow it does not make sense for those to be in the std crate because they are a user-facing, but keeping those descriptions attached to the callable objects makes it easier to update them. If we moved everything to the repl crate, then we'd need a way to ensure all registered commands and functions are documented, which kinda violates layering principles...

@jmmv jmmv added the refactoring Internal changes that are not user visible enhancements label Oct 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Internal changes that are not user visible enhancements
Projects
None yet
Development

No branches or pull requests

1 participant