Skip to content

Add doc block for IQuery.projection#3919

Merged
sbesson merged 2 commits intoome:developfrom
joshmoore:unit-projections-doc
Jul 2, 2015
Merged

Add doc block for IQuery.projection#3919
sbesson merged 2 commits intoome:developfrom
joshmoore:unit-projections-doc

Conversation

@joshmoore
Copy link
Copy Markdown
Member

IProjection is the only location which is currently
using the JSON-like serialization of Perms and Units.
It seems useful then to place the documentation for
these directly on the method.

See: https://trello.com/c/vdyTStEq/40-unit-documentation

IProjection is the only location which is currently
using the JSON-like serialization of Perms and Units.
It seems useful then to place the documentation for
these directly on the method.

See: https://trello.com/c/vdyTStEq/40-unit-documentation
@mtbc
Copy link
Copy Markdown
Member

mtbc commented Jul 1, 2015

The text looks good and documentation is to be encouraged. 👍 One niggle is that I don't see the nice formatting in dist/docs/api/slice2html/omero/api/IQuery.html, it is instead all collapsed into a single paragraph and the separate HQL examples all run together.

@joshmoore
Copy link
Copy Markdown
Member Author

Pushed. Open to suggestions; this is readable in the HTML now, but less so in the .ice. :/

@mtbc
Copy link
Copy Markdown
Member

mtbc commented Jul 1, 2015

Looks good in the HTML indeed; this PR is good to merge.

If you prefer, could revert back to something more like your original, with: add "(a)", "(b)", bullets, punctuation to turn that first <ul> list into something that reads okay when concatenated, and have the only actual markup be the <pre> block; or, some other tradeoff among the formats. Up to you.

@joshmoore
Copy link
Copy Markdown
Member Author

Hmmm....perhaps that means we're either making a decision about how we all want to add slice doc blocks, or we're punting and we'll clean this up later. I'm open either way. cc: @hflynn @sbesson

@sbesson
Copy link
Copy Markdown
Member

sbesson commented Jul 2, 2015

Got thumbs up from @hflynn. No strong feeling from my side on the formatting policy. Merging. We can always unify later.

sbesson added a commit that referenced this pull request Jul 2, 2015
Add doc block for IQuery.projection
@sbesson sbesson merged commit c402154 into ome:develop Jul 2, 2015
@sbesson sbesson added this to the 5.1.3 milestone Jul 17, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants