-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from draeger-lab/dev
Dev->main in preparation for release 0.0.dev1
- Loading branch information
Showing
37 changed files
with
14,969 additions
and
3,269 deletions.
There are no files selected for viewing
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
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Developer Zone | ||
|
||
This is a directory containing information, notebooks with open work and testing examples and much more for the developers of the SPECIMEN package. It also serves as an additional hub, where developers can share and discuss their code. | ||
|
||
Additionally, some helpful code for making developement easier and standardised between developers has been added here as well. | ||
|
||
More information about the different files collected here can be found below. | ||
|
||
## Working Progress Notebooks | ||
|
||
- ``test_modules``: <br> | ||
Test the different workflows their substeps. <br> | ||
Status: Ready to run, just adjust the parameters | ||
|
||
## Help with Coding | ||
|
||
- `docstring-format.mustache`<br> | ||
As the name suggest, this file contains the basic setup for the docstring | ||
format used for this package. It can be integrated into your IDE (e.g. VSCode) to allow autodoc to use the correct style. | ||
- `TodoTree_params.txt`<br> | ||
If you use VSCode, you can install the TodoTree extension and add this file to your settings.json. It will highlight all listed keyword can collect them in a seperate tab. This makes it easier to track TODOs, points of DISCUSSIONs and more and allows faster identification of open issues inside the code. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
"todo-tree.general.statusBar": "tags", | ||
"todo-tree.general.tags": [ | ||
"@BUG", | ||
"@HACK", | ||
"@FIXME", | ||
"@TODO", | ||
"XXX", | ||
"[ ]", | ||
"[x]", | ||
"@TEST", | ||
"@DEPRECATE", | ||
"@NOTE", | ||
"@DISCUSSION", | ||
"@DEBUG" | ||
], | ||
"todo-tree.highlights.backgroundColourScheme": [ | ||
"red", | ||
"orange", | ||
"yellow", | ||
"cyan", | ||
"blue", | ||
"indigo", | ||
"violet", | ||
"#ff43a4", | ||
"#c0c0c0", | ||
"#f5bd02", | ||
"violet", | ||
"#329542" | ||
], | ||
"todo-tree.highlights.foregroundColourScheme": [ | ||
"white", | ||
"black", | ||
"black", | ||
"black", | ||
"white", | ||
"white", | ||
"black", | ||
"black", | ||
"black", | ||
"black", | ||
"black", | ||
"white" | ||
], | ||
"todo-tree.highlights.useColourScheme": true, | ||
"todo-tree.tree.showCountsInTree": true, | ||
"todo-tree.general.showActivityBarBadge": true, | ||
"todo-tree.general.showIconsInsteadOfTagsInStatusBar": true, | ||
"todo-tree.highlights.customHighlight":{ | ||
"@TODO": { | ||
"icon": "check-circle" | ||
}, | ||
"@BUG": { | ||
"icon": "bug" | ||
}, | ||
"@HACK": { | ||
"icon": "tools" | ||
}, | ||
"@FIXME": { | ||
"icon": "flame" | ||
}, | ||
"XXX": { | ||
"icon": "x" | ||
}, | ||
"[ ]": { | ||
"icon": "issue-draft" | ||
}, | ||
"[x]": { | ||
"icon": "issue-closed" | ||
}, | ||
"@TEST": { | ||
"icon": "beaker" | ||
}, | ||
"@DEPRECATE": { | ||
"icon": "trash" | ||
}, | ||
"@NOTE": { | ||
"icon": "note" | ||
}, | ||
"@DISCUSSION": { | ||
"icon": "comment-discussion" | ||
}, | ||
"@DEBUG": { | ||
"icon": "bug" | ||
} | ||
}, | ||
"todo-tree.general.tagGroups": { | ||
|
||
}, |
Oops, something went wrong.