Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document latest OMERO.matlab functions #566

Merged
merged 10 commits into from
Dec 4, 2013
Merged

Conversation

sbesson
Copy link
Member

@sbesson sbesson commented Nov 29, 2013

Fixes notably https://trac.openmicroscopy.org.uk/ome/ticket/11681

This PR adds documentation for recent additions to the OMERO.matlab:

  • add a table for the annotations functions at the beginning of the annotation section
  • add small description for the write*Annotation and linkAnnotation functions
  • add small description for the uploadFileAnnotation replacement function
  • fix CreateImage and RenderImages examples at the bottom by linking to the Training examples
  • add small paragraph about toByteArray function

retrieved from the server using the :source:`getTagAnnotations <components/tools/OmeroM/src/annotations/getTagAnnotations.m>`
If the identifier of the annotation of a given type is known, the annotation
can be retrieved from the server using the corresponding function, e.g. for
tags using the :source:`getTagAnnotations <components/tools/OmeroM/src/annotations/getTagAnnotations.m>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double space


:source:`getPlateTagAnnotations <components/tools/OmeroM/src/annotations/getPlateTagAnnotations.m>`, :source:`getPlateFileAnnotations <components/tools/OmeroM/src/annotations/getPlateFileAnnotations.m>`, :source:`getPlateCommentAnnotations <components/tools/OmeroM/src/annotations/getPlateCommentAnnotations.m>`, :source:`getPlateFileAnnotations <components/tools/OmeroM/src/annotations/getPlateFileAnnotations.m>`
Utility function to retrieve annotations linked to plates
To replace the content of an existing file annotation,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is confusing - I don't see a difference between the two function invocations (besides the mysterious faid parameter). Also the paragraph ends abruptly with a comma.

@bpindelski
Copy link

3 comments left.

@sbesson
Copy link
Member Author

sbesson commented Dec 2, 2013

@bpindelski: last 2 commits should address most of your comments.

@bpindelski
Copy link

Built the docs locally and checked - all looks fine now. Good to merge.

@hflynn
Copy link
Member

hflynn commented Dec 4, 2013

Thanks.
@sbesson are these changes applicable to 4.4.9 too? If so, can you rebase so I can update those docs too, please?

hflynn added a commit that referenced this pull request Dec 4, 2013
Document latest OMERO.matlab functions
@hflynn hflynn merged commit 10736ec into ome:develop Dec 4, 2013
@sbesson
Copy link
Member Author

sbesson commented Dec 4, 2013

--rebased-to #571

@sbesson sbesson deleted the 11681_tobytearray branch December 4, 2013 11:43
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.

None yet

4 participants