Skip to content

Commit

Permalink
Improve docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
MicheleBortol committed Aug 1, 2024
1 parent 657aa87 commit 678a487
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions omero_vitessce/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ def create_dataset_config(dataset_id, conn):
def create_image_config(image_id):
"""
Generates a Vitessce config for an OMERO image and returns it.
Assumes the images is a zarr file
Assumes the images is an OME-NGFF v0.4 file
which can be served with omero-web-zarr.
"""
vc = VitessceConfig(schema_version="1.0.6")
Expand All @@ -100,7 +100,7 @@ def create_image_config(image_id):
def attach_config(vc, obj_type, obj_id, conn):
"""
Generates a Vitessce config for an OMERO image and returns it.
Assumes the images is a zarr file
Assumes the images is an OME NGFF v0.4 file
which can be served with omero-web-zarr.
"""
with tempfile.NamedTemporaryFile(mode="w", suffix=".json.txt",
Expand Down Expand Up @@ -138,9 +138,9 @@ def vitessce_panel(request, obj_type, obj_id, conn=None, **kwargs):

@login_required(setGroupContext=True)
def generate_config(request, obj_type, obj_id, conn=None, **kwargs):
"""Get all .json.txt attachements and generate links for them
This way the config files can be served as text
to the config argument of the vitessce webapp
"""Generate a config file for the selected image/dataset,
write it to a temporarily file and attach it. Then open the
viewer with the autogenerated config.
"""
obj_id = int(obj_id)
if obj_type == "image":
Expand Down

0 comments on commit 678a487

Please sign in to comment.