user_guide icon indicating copy to clipboard operation
user_guide copied to clipboard

Included documentation of secondary files

Open Mackenzie-OO7 opened this issue 2 years ago • 9 comments

This PR:

  • solves https://github.com/common-workflow-language/common-workflow-language/issues/270
  • fixes typos and punctuation errors
  • paraphrases some sentences to be better understood

Mackenzie-OO7 avatar Oct 19 '22 00:10 Mackenzie-OO7

@kinow Thanks for reviewing. I've implemented the changes you suggested.

Mackenzie-OO7 avatar Oct 19 '22 07:10 Mackenzie-OO7

@kinow Thanks for reviewing. I've implemented the changes you suggested.

Hi all - My only concern is 2 things (1) making sure people know making a template is optional (2) you can use a shortcut to adding secondary files. It need not include all of those parts. For example: vcfgz: type: File secondaryFiles: [.txt]

Would be valid in this case

swzCuroverse avatar Oct 19 '22 13:10 swzCuroverse

@tetron can you give your take on secondary files and then merge when we resolve the issue?

swzCuroverse avatar Oct 19 '22 13:10 swzCuroverse

@swzCuroverse I've made some changes, is it okay now?

Mackenzie-OO7 avatar Oct 21 '22 09:10 Mackenzie-OO7

@Mackenzie-OO7 could you give this pull request a more descriptive title? The PR title does not indicate that you are added documentation about secondary files.

tetron avatar Oct 24 '22 18:10 tetron

@Mackenzie-OO7 could you give this pull request a more descriptive title? The PR title does not indicate that you are added documentation about secondary files.

Alright. Is it better now?

Mackenzie-OO7 avatar Oct 24 '22 19:10 Mackenzie-OO7

Alright. Is it better now?

Yes, thank you!

tetron avatar Oct 24 '22 20:10 tetron

@tetron I've made the changes requested.

Mackenzie-OO7 avatar Oct 31 '22 19:10 Mackenzie-OO7

@Mackenzie-OO7

Happy to get you back working on this. I believe the issues is that you are describing what the parser does more than what the user will do in the last section --- Let me make some suggestions on the text.

swzCuroverse avatar Jan 10 '23 13:01 swzCuroverse