Improve and add docstring #14
Conversation
Example 2 is using a reference channel and a reference tile.
Modifies the values of the default options to use the user input. Also add the possibility to work with ranges.
…rocessing-options-class
This uses caplog and requires the new MOCK done by @ehrenfeu
| def process_illumination( | ||
| self, value, range_end=None | ||
| ): # def illumination_select(self, value): |
There was a problem hiding this comment.
This still needs some attention: the # def illumination_select(self, value): was added when I renamed the function to make it easier to check for required changes in existing scripts (that might have used the function under its original name) to find the correct new function name by simply using a string-search on the code.
Currently this triggers the formatter to break up the function definition statement into three lines, which is rather pointless.
One possible / reasonable option is to add a Notes section to the docstring e.g. like this:
def process_illumination(self, value, range_end=None):
"""Blah docstring title.
[...]
Notes
-------
Previous function name: illumination_select()
"""|
|
||
| Parameters | ||
| ---------- | ||
| value : int or int-like | ||
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel |
There was a problem hiding this comment.
Line is too long
Please don't write what the parameter contains if used correctly, rather look at the phrasing from the perspective of someone not knowing the method and trying to figure out what should go in there, e.g.
"The illuminations to use for processing, either a single value or a list."
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel | ||
| range_end : int, optional | ||
| Contains the end of the range, by default None |
| self._illumination_processing_option = processing_option | ||
| self._illumination_select = dimension_select | ||
|
|
||
| def process_tile(self, value, range_end=None): # def tile_select(self, value): |
There was a problem hiding this comment.
Same as for L232 (docstring notes section)
| def process_timepoint( | ||
| self, value, range_end=None | ||
| ): # def timepoint_select(self, value): |
There was a problem hiding this comment.
Same as for L232 (docstring notes section)
|
|
||
| Parameters | ||
| ---------- | ||
| value : int or int-like | ||
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel |
There was a problem hiding this comment.
Line too long, see comment for L241
|
|
||
| Parameters | ||
| ---------- | ||
| value : int or int-like | ||
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel |
There was a problem hiding this comment.
Line too long, see comment for L241
|
|
||
| Parameters | ||
| ---------- | ||
| value : int or int-like | ||
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel |
There was a problem hiding this comment.
Line too long, see comment for L241
| Parameters | ||
| ---------- | ||
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel |
There was a problem hiding this comment.
Line too long, see comment for L241
| selection : str | ||
| "single", "multiple", or "range" | ||
| value : str, int, list of int or list of str | ||
| Contains the list of input dimensions, the first input dimension of a range or a single channel |
There was a problem hiding this comment.
Line too long, see comment for L241
No description provided.