Skip to content
This repository has been archived by the owner on Dec 7, 2018. It is now read-only.

Move example to files #51

Merged
merged 7 commits into from
Jul 18, 2018
Merged

Conversation

Cyberface
Copy link
Contributor

We wanted to move the example config code to files in the repo.

This starts this process and provides an example how to link the
files to the documentation.

@Cyberface
Copy link
Contributor Author

currently this example lives in examples/workflow/make_workflow.

I don't really like the name make_workflow so better ideas are welcome!

@coveralls
Copy link

coveralls commented Jul 18, 2018

Pull Request Test Coverage Report for Build 190

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 40.648%

Totals Coverage Status
Change from base Build 186: 0.0%
Covered Lines: 1067
Relevant Lines: 2625

💛 - Coveralls

@duncanmmacleod
Copy link
Member

@Cyberface, why not just have these files live in /examples/workflow/, what's the motivation for the extra depth?

@duncanmmacleod duncanmmacleod added pr:bug-fix Backwards-compatible change that does not add new functionality (patch version bump) documentation Changes to code documentation labels Jul 18, 2018
@Cyberface
Copy link
Contributor Author

@duncanmmacleod because there could be multiple different workflow types. For example there is another type here: https://gwin.readthedocs.io/en/latest/command-line/gwin_make_inj_workflow.html

That I was going to put in after this

@duncanmmacleod
Copy link
Member

@Cyberface, then why not just call the relevant file /examples/workflow/basic.ini and have the workflow with injections called /examples/workflow/injection.ini or similar. We don't need to use gwin.ini IMHO.

@Cyberface
Copy link
Contributor Author

@duncanmmacleod I like have separate sub-directories to keep the examples really self contained. If you just have /examples/workflow/ then you would have multiple .ini files that are not all compatible with each other.

We need another person to settle this :)

@Cyberface
Copy link
Contributor Author

@cdcapano we need your input

Copy link
Collaborator

@cdcapano cdcapano left a comment

Choose a reason for hiding this comment

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

I'm fine with the sub-directory, but call it something more informative, like 'gw150914', instead of 'make_workflow'.

@cdcapano cdcapano merged commit 6887e00 into gwastro:master Jul 18, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Changes to code documentation pr:bug-fix Backwards-compatible change that does not add new functionality (patch version bump)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants