Initial Commit Help Pages #48
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Krannich479
added
documentation
|
I'll look over the actual helppage content later |
Krannich479
requested changes
May 16, 2024
eval.nf
Outdated
| @@ -1,3 +1,10 @@ | |||
| //load in help function | |||
| File data_class_file = new File("./src/data_class.groovy"); | |||
There was a problem hiding this comment.
Can you please rename that file into something like Helppages.groovy? This describes the purpose of the class more intuitively.
There was a problem hiding this comment.
Same for the variable's name data_class_file -> helppages_class_file
eval.nf
Outdated
| @@ -1,3 +1,10 @@ | |||
| //load in help function | |||
| File data_class_file = new File("./src/data_class.groovy"); | |||
| Class groovyClass = new GroovyClassLoader(getClass().getClassLoader()).parseClass(data_class_file); | |||
There was a problem hiding this comment.
Same: groovyClass -> HelppagesClass
eval.nf
Outdated
| //load in help function | ||
| File data_class_file = new File("./src/data_class.groovy"); | ||
| Class groovyClass = new GroovyClassLoader(getClass().getClassLoader()).parseClass(data_class_file); | ||
| GroovyObject data_class = (GroovyObject) groovyClass.newInstance(); |
There was a problem hiding this comment.
Same: data_class -> help
eval.nf
Outdated
| Class groovyClass = new GroovyClassLoader(getClass().getClassLoader()).parseClass(data_class_file); | ||
| GroovyObject data_class = (GroovyObject) groovyClass.newInstance(); | ||
|
|
||
| if (params.help) { exit 0, data_class.helpEval(workflow.manifest.version) } |
There was a problem hiding this comment.
Needs then adjustment to new name
hap.nf
Outdated
| @@ -1,3 +1,10 @@ | |||
| //load in help function | |||
| File data_class_file = new File("./src/data_class.groovy"); | |||
Krannich479
approved these changes
May 16, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One can now run:
nextflow run eval.nf --helpornextflow run hap.nf --help,to see a help page with minimal usage examples and parameter explanations.
Issue: #39