Add some RecipeRule documentation#1283
Merged
David-Baddeley merged 2 commits intoSep 26, 2022
Merged
Conversation
| Note that in this case, only a single file is passed as the input shape. | ||
| However, the server expects a list and therefore treats the input name | ||
| ``shape`` as a stub. In the event only a single input is in the list, | ||
| the input is named ``shape_shape`` (stub followed by stub). |
Contributor
There was a problem hiding this comment.
This is incorrect - the <input_name>_<table_name> pattern only applies to HDF files which can contain multiple data tables (ie you can't assume that an HDF only contains a single table), and has nothing to do with whether the inputs is a list or not.
Member
Author
There was a problem hiding this comment.
Good to know. I took a guess on this one because I couldn't find where it maps the name. Where does the <input_name>_<table_name> bit happen?
Contributor
There was a problem hiding this comment.
Recipe._inject_tables_from_hdf5() (line 558 of recipe.py). Looking at the code there, if you use the 'input' as the key to the rule etc ... it will just inject with the table name.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Some documentation for
RecipeRules, based on recent experiences. Probably this belongs indocs/cluster/programatic_usage.rstfrom #1281, rather than in its ownrules.rst.