Skip to content
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

Included documentation of secondary files #318

Open
wants to merge 28 commits into
base: main
Choose a base branch
from

Conversation

Mackenzie-OO7
Copy link
Contributor

This PR:

Copy link
Member

@kinow kinow left a comment

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 !

src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Show resolved Hide resolved
@Mackenzie-OO7
Copy link
Contributor Author

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

@swzCuroverse
Copy link
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
Contributor

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

@Mackenzie-OO7
Copy link
Contributor Author

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

@tetron
Copy link
Member

tetron commented Oct 24, 2022

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

src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
@tetron
Copy link
Member

tetron commented Oct 24, 2022

Alright. Is it better now?

Yes, thank you!

@Mackenzie-OO7
Copy link
Contributor Author

@tetron I've made the changes requested.

@swzCuroverse
Copy link
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.

src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
src/topics/inputs.md Show resolved Hide resolved
src/topics/inputs.md Outdated Show resolved Hide resolved
@Mackenzie-OO7 Mackenzie-OO7 deleted the restructure-content branch January 25, 2023 15:28
@Mackenzie-OO7 Mackenzie-OO7 restored the restructure-content branch January 25, 2023 15:33
@Mackenzie-OO7 Mackenzie-OO7 reopened this Jan 25, 2023
src/topics/inputs.md Outdated Show resolved Hide resolved
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

Successfully merging this pull request may close these issues.

None yet

5 participants