Skip to content

Update docs for metadata parameter of write_image - #584

Open
keller-mark wants to merge 2 commits into
ome:masterfrom
keller-mark:keller-mark/metadata-param
Open

Update docs for metadata parameter of write_image#584
keller-mark wants to merge 2 commits into
ome:masterfrom
keller-mark:keller-mark/metadata-param

Conversation

@keller-mark

Copy link
Copy Markdown
Contributor

The ** for the **metadata kwarg was confusing to me. It wasn't initially apparent to me via the type anotations or docstring whether I should do write_image(omero={}) vs write_image(metadata={"omero":{}}). Only the latter works.

write_image(
    image=img_arr,
    # other args here
    metadata={
        "omero": {
            "name": img_name,
        }
    }
)

@jo-mueller

Copy link
Copy Markdown
Collaborator

@keller-mark I think this looks good, but since the merge of #515 you'll need to rebase. OR check out the new API introduced there, which should make writing the omero metadata a tad easier!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants