Skip to content

Included documentation of secondary files - #318

Open
Mackenzie-OO7 wants to merge 28 commits into
common-workflow-language:mainfrom
Mackenzie-OO7:restructure-content
Open

Included documentation of secondary files#318
Mackenzie-OO7 wants to merge 28 commits into
common-workflow-language:mainfrom
Mackenzie-OO7:restructure-content

Conversation

@Mackenzie-OO7

Copy link
Copy Markdown
Contributor

This PR:

@kinow kinow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick review during lunch break 🏃‍♂️ Thanks @Mackenzie-OO7 !

Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md
@Mackenzie-OO7

Copy link
Copy Markdown
Contributor Author

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

@swzCuroverse

Copy link
Copy Markdown
Contributor

@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

Copy link
Copy Markdown
Contributor

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

@Mackenzie-OO7

Copy link
Copy Markdown
Contributor Author

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

@tetron

tetron commented Oct 24, 2022

Copy link
Copy Markdown
Member

@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.

@Mackenzie-OO7 Mackenzie-OO7 changed the title Updated inputs.md Included documentation of secondary files Oct 24, 2022
@Mackenzie-OO7

Copy link
Copy Markdown
Contributor Author

@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?

Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md Outdated
@tetron

tetron commented Oct 24, 2022

Copy link
Copy Markdown
Member

Alright. Is it better now?

Yes, thank you!

@Mackenzie-OO7
Mackenzie-OO7 requested a review from tetron October 29, 2022 06:19
@Mackenzie-OO7

Copy link
Copy Markdown
Contributor Author

@tetron I've made the changes requested.

@swzCuroverse

Copy link
Copy Markdown
Contributor

@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.

Comment thread src/topics/inputs.md Outdated
Comment thread src/topics/inputs.md