README - update writelto, attempts to fix #169 #196
Conversation
README.md
Outdated
| @@ -108,11 +108,9 @@ Whenever a tape is ejected, the script will export the tape’s index (as an XML | |||
| To write data onto a tape, run the following command: | |||
|
|
|||
| ``` | |||
| writelto | |||
| writelto -t $tape_serial /Volumes/$tape_serial | |||
There was a problem hiding this comment.
That would write the content of the lto tape onto the same lto tape. A better example would be:
writelto -t $tape_serial $any_other_place
|
Lol I'm sorry, I'm going pretty blind here.looks like your PR would make this redundant as the docs would be correct of that was merged? |
|
I think that even after that PR is merged, the docs still should be updated along the lines you are doing! I see that PR more as a check against data not being entered initially. People should probably know that they need to add both those values for a complete executable command. |
| @@ -108,11 +108,9 @@ Whenever a tape is ejected, the script will export the tape’s index (as an XML | |||
| To write data onto a tape, run the following command: | |||
|
|
|||
| ``` | |||
| writelto | |||
| writelto -t $tape_serial $source_directory | |||
There was a problem hiding this comment.
sorry to nitpick, but I think maybe writing inputs as variables in the docs might confuse some people who aren't familiar with $ denoting a user changeable variable?
I never am sure of the most intuitive way to denote user inputs in docs, but maybe TAPE_SERIAL and SOURCE_DIRECTORY, or possibly [Tape Serial] [Source Directory]? (Although when I have used the latter format I often find myself having to explain that the [ ] are not part of the command. I wonder if there is any common precedent across amiaos repos?
|
I agree, maybe the all caps, with an example command to make it extra clear? |
|
I think that makes sense! |
|
ping |
|
ping ping |
|
Has this PR not been superseded by ed8ccab? |
I'm almost certain that this is fairly wrong in a few ways, but maybe it'll get the ball rolling. Any edits/fixes are very welcome..