Skip to content

Improvement suggestions to CSE-CLI documentation page #12

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

Open
cesarcarc opened this issue Apr 15, 2020 · 2 comments
Open

Improvement suggestions to CSE-CLI documentation page #12

cesarcarc opened this issue Apr 15, 2020 · 2 comments

Comments

@cesarcarc
Copy link
Contributor

cesarcarc commented Apr 15, 2020

Comments below refer to https://open-simulation-platform.github.io/cse-cli

  • I believe it is missing a link to how to make the command line cse-cli available for the user (download and installing it), meaning which steps are needed prior to execute the commands.
  • "This page collects design ideas for the CSE command-line interface (CLI).". This should be removed, as the design phase is over.

About "Functionality and Design":

  • "Run a simulation, where the system to simulate is specified as an SSP file.". Only for SSP? I think this is outdated.
  • Spacing in between the bullet points is a bit strange
  • "Do a “test run” with a single model (FMU). The following is an unsorted list of loose design ideas and desirable features. A more detailed specification is given in the form of “help texts” in the next section." First sentence is fine, the rest should be deleted.

About Functional specification

  • "Here, we specify the functionality of the software in the form of imagined interactions with a user. This includes a somewhat formal specification given by the output of the cse help commands.". I think we are over the imagined interactions. This text should be updated/removed.

About General usage

  • I think this part should be more user friendly. Maybe add a description before showing the commands (the same applies for the next subsections).
  • I've downloaded release version 0.2.0 and I noticed some differences between the response of the commands when compared to what is the documentation page. For "cse help" mostly on synopsis and subcommands. "cse help run" is also different.
@yingguangchu
Copy link
Contributor

Updated the cmd and help response to v.0.2.0
@kyllingstad perhaps you could also help to review this?

@yingguangchu
Copy link
Contributor

Have merged this branch. PR #15.
May close this issue if you think it's ok. @cesarcarc

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

No branches or pull requests

2 participants