Update command-line-tool.md #344
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added description about how command line tools work and different user cases for arguments and input
swzCuroverse
reviewed
Nov 8, 2022
src/topics/command-line-tool.md
Outdated
| @@ -10,6 +10,9 @@ The following example contains a minimal example of a CWL | |||
| command-line tool for the `echo` Linux command, using inputs and | |||
| outputs. | |||
|
|
|||
| How Command-lines work | |||
| A Command Line Tool is a non-interactive executable program that reads some input, performs a computation, and terminates after producing some output. Command line programs are a flexible unit of code sharing and reuse, unfortunately the syntax and input/output semantics among command line programs is extremely heterogeneous. A common layer for describing the syntax and semantics of programs can reduce this incidental complexity by providing a consistent way to connect programs together. This specification defines the Common Workflow Language (CWL) Command Line Tool Description, a vendor-neutral standard for describing the syntax and input/output semantics of command line programs. | |||
There was a problem hiding this comment.
This looks like it is quoting something, if so, we need it to be properly attributed. I would prefer a shorter paraphrase if possible
There was a problem hiding this comment.
Hello @swzCuroverse thank you for the feedback, i have made a commit with changes.
swzCuroverse
reviewed
Nov 8, 2022
src/topics/command-line-tool.md
Outdated
| @@ -10,6 +10,9 @@ The following example contains a minimal example of a CWL | |||
| command-line tool for the `echo` Linux command, using inputs and | |||
| outputs. | |||
|
|
|||
| How Command-lines work | |||
There was a problem hiding this comment.
This needs to be capitalized like a tile. I would also suggest something else since this doesn't really describe how they work
There was a problem hiding this comment.
Hello @swzCuroverse thank you for the feedback, i have made a commit with changes.
swzCuroverse
reviewed
Nov 8, 2022
src/topics/command-line-tool.md
Outdated
| @@ -63,7 +66,70 @@ and in the [Outputs](../topics/outputs.md) sections. | |||
| % | |||
| % - Spaces in commands https://github.com/common-workflow-language/user_guide/issues/39 | |||
| % - Arguments (tell the reader the different use cases for arguments and inputs, tell them there is a section about inputs) | |||
| Different use cases for arguments and inputs | |||
There was a problem hiding this comment.
This seems to just be a phrase (not a full sentence) instead of explanation of the differences
There was a problem hiding this comment.
Hello @swzCuroverse thank you for the feedback, i have made a commit with the differences and use cases
On Line 13, i changed the Heading "How command lines work" from small letters to upper case On Line 14, I removed the old description "A Command Line Tool is a non-interactive executable program that reads some input, performs a computation, and terminates after producing some output. Command line programs are a flexible unit of code sharing and reuse, unfortunately the syntax and input/output semantics among command line programs is extremely heterogeneous. A common layer for describing the syntax and semantics of programs can reduce this incidental complexity by providing a consistent way to connect programs together. This specification defines the Common Workflow Language (CWL) Command Line Tool Description, a vendor-neutral standard for describing the syntax and input/output semantics of command line programs" to a new text "The command line is a text interface for your computer. It’s a program that takes in commands, which it passes on to the computer’s operating system to run. From the command line, you can navigate through files and folders on your computer, just as you would with Windows Explorer on Windows or Finder on Mac OS. The difference is that the command line is fully text-based. Abbreviated as CLI, a Command Line Interface connects a user to a computer program or operating system. Through the CLI, users interact with a system or application by typing in text (commands). The command is typed on a specific line following a visual prompt from the computer. The system responds to the text, and the user may then type on the next command line that appears. Through this command and response interaction, the user is able to issue a series of commands, which are executed by the system or program. Systems and software can provide users with both CLI and Graphical User Interface (GUI) options"
On line 69, I changed the text "Different use case for arguments and inputs" from lower case to upper case. On line 70-71, I explain the differences between arguments and input On line 72, I tell the reader that they will learn more about inputs in section 2.4 On line 74-76 I gave use cases for command line arguments
| @@ -10,6 +10,13 @@ The following example contains a minimal example of a CWL | |||
| command-line tool for the `echo` Linux command, using inputs and | |||
| outputs. | |||
|
|
|||
| HOW COMMAND LINES WORK | |||
| The command line is a text interface for your computer. It’s a program that takes in commands, which it passes on to the computer’s operating system to run. From the command line, you can navigate through files and folders on your computer, just as you would with Windows Explorer on Windows or Finder on Mac OS. The difference is that the command line is fully text-based. Abbreviated as CLI, a Command Line Interface connects a user to a computer program or operating system. Through the CLI, users interact with a system or application by typing in text (commands). The command is typed on a specific line following a visual prompt from the computer. Abbreviated as CLI, a Command Line Interface connects a user to a computer program or operating system. Through the CLI, users interact with a system or application by typing in text (commands). The command is typed on a specific line following a visual prompt from the computer. | |||
|
|
|||
There was a problem hiding this comment.
I don't think this much is needed. Perhaps just a quick mention about what command line tools are and that CWL is designed to run them --- such as
"CWL is used to run analyzes consisting of command line programs. Command line programs operates from the command line or from a shell"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added description about how command line tools work and different user cases for arguments and input