Skip to content

Commit

Permalink
DOC: Don't mention Py 3 requirement in _parse_roi_file_py3
Browse files Browse the repository at this point in the history
Because we automatically switch it out for a Python 2 compatible
version, and the docstring is rendered as if it is for the
wrapper parse_roi_file, which supports both python 2 and python 3.
  • Loading branch information
scottclowe committed Jun 28, 2021
1 parent 53a7efc commit bafbb29
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions fissa/readimagejrois.py
Expand Up @@ -285,9 +285,6 @@ def _parse_roi_file_py3(roi_source):
"""
Parse an individual ImageJ ROI.
This implementation utilises the read_roi package, which is more robust
but only supports Python 3+ and not Python 2.7.
Parameters
----------
roi_source : str or file object
Expand All @@ -306,6 +303,9 @@ def _parse_roi_file_py3(roi_source):
ValueError
If unable to parse ROI.
"""
# This implementation utilises the read_roi package, which is more robust
# but only supports Python 3+ and not Python 2.7.

# Use read_roi package to load up the roi as a dictionary
roi = read_roi.read_roi_file(roi_source)
# This is a dictionary with a single entry, whose key is the label
Expand Down

0 comments on commit bafbb29

Please sign in to comment.