doc: add a little warning for <param ... multiple="true"> #930
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
nsoranzo
reviewed
May 5, 2019
Co-Authored-By: bernt-matthias <m.bernt@ufz.de>
nsoranzo
reviewed
May 5, 2019
Co-Authored-By: bernt-matthias <m.bernt@ufz.de>
Co-Authored-By: bernt-matthias <m.bernt@ufz.de>
…tthias/planemo into topic/doc-multiple-true
nsoranzo
reviewed
May 6, 2019
| - to access properties of the collection (name,...), or | ||
| - to write tests that pass a collection to the parameter (which would allow to name the elements explicitly). | ||
|
|
||
| Another drawback is that the `${on_string}` of the label contains the list of data sets in the collection (which can be confusing, since these data sets are in most cases hidden) and not the name of the collection. |
There was a problem hiding this comment.
That's probably something which we may want to fix?
jmchilton
reviewed
May 8, 2019
docs/_writing_collections.rst
Outdated
| @@ -125,13 +125,22 @@ Processing Lists (Reductions) | |||
| ------------------------------- | |||
|
|
|||
| The ``data_collection`` parameter type can specify a ``collection_type`` or | |||
| ``list`` but whenever possible, it is actually better to not explicitly | |||
| ``list`` but whenever possible, it might actually be better to not explicitly | |||
There was a problem hiding this comment.
This represented an IUC recommendation... I think I agree with the language changes here - but I was always more pro-collection inputs then everyone else. So I'm nervous about making this less of a recommendation.
There was a problem hiding this comment.
Agreed. I changed the wording to "it is recommended".
jmchilton
approved these changes
May 8, 2019
nsoranzo
reviewed
May 9, 2019
Co-Authored-By: Nicola Soranzo <nicola.soranzo@gmail.com>
nsoranzo
approved these changes
May 9, 2019
|
Thanks so much! |
4 tasks
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.
I stumbled over this multiple times...
Wondering what happens if the user selects multiple collections in such an input field