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

Remove lex, format, and minify from README #92

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aluttik
Copy link
Contributor

@aluttik aluttik commented Nov 3, 2020

There's not a lot of reason to include lex, format, and minify in the README. They just clutter up the docs, create confusion about the point of crossplane, and keeping them in creates a responsibility for devs to maintain them. I don't think we should remove the capabilities from the tool, though, to maintain backwards compatibility.

This would also solve #90.

There's not a lot of reason to include `lex`, `format`, and `minify` in the README. They just clutter up the docs, create confusion about the point of crossplane, and keeping them in creates a responsibility to maintain them. I don't think we should remove the capabilities from the tool, though, to maintain backwards compatibility.
@ornj
Copy link
Member

ornj commented Nov 3, 2020

I agree that there is little reason to include information in the readme that can otherwise be obtained from the command line with --help. Documentation of crossplane's API would be better placed as docstrings where they would be easier to keep up to date and provide additional value when help() is used in the repl.

@AnotherZane
Copy link

AnotherZane commented Jan 3, 2021

I agree that there is little reason to include information in the readme that can otherwise be obtained from the command line with --help.

Well yes, but some new users might not have the cli tool installed. I think they should have a way to know that these sub commands exist.

I think moving it to a wiki page would be a better idea than entirely removing it.

@aluttik
Copy link
Contributor Author

aluttik commented Jul 20, 2021

I would recommend getting rid of these subcommands entirely, but to maintain backwards compatibility they should at least work until a new major version comes out.

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 this pull request may close these issues.

3 participants