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

Improve documentation and --help in the context of SIP-46-related changes #1370

Closed
Gedochao opened this issue Sep 16, 2022 · 0 comments · Fixed by #1587
Closed

Improve documentation and --help in the context of SIP-46-related changes #1370

Gedochao opened this issue Sep 16, 2022 · 0 comments · Fixed by #1587
Labels
SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.

Comments

@Gedochao
Copy link
Contributor

Gedochao commented Sep 16, 2022

Describe what needs to be done and why
This is a catch-all ticket for docs and help improvements tied to our SIP

Related tickets
#1309
#1308

To Do

  • document all the behaviours tied to the default command (when scala-cli is called without explicitly passing a sub-command)
    • those should be at least broadly made clear in the relevant --help
    • a cookbook giving examples of all the less obvious behaviours would probably be useful
  • document backwards compatibility with the scala command
    • in particular, all known incompatibilities which we won't fix should be documented (i.e. passing a main class as an input instead of the --main-class option)
  • future-proof our docs website for post-SIP
  • ... (probably more to come)
@Gedochao Gedochao added the SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command. label Sep 16, 2022
@tgodzik tgodzik moved this to Done in Scala CLI Board Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SIP-46 All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant