Add contributing to documentation #294
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
Add a nosetest that checks all yaml structured files (= files with `.yaml` or `. yml` extension) in `examples/exampleSettings`. All found files are validated using PyKwalify and the paramSchema and functions in PyRadiomics Additionally, add a simple python script to manually test a parameter file (`bin/testParams`).
Change CONRTRIBUTING.md to restructured text and include it in the sphinx generated documentation. Additionally, add a section to encourage users to share their parameter files in the PyRadiomics repository.
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.
Include the contributing file in the Sphinx generated documentation and add a section on how users can share their parameter files in the repository.
Also includes a new test script to check if all example parameter files (all files with extension ".yml" or ".yaml" in the
examples/exampleSettingsfolder) are valid.cc @Radiomics/developers