Add an Ops philosophy#112
Conversation
|
@gselzer So far I like the document and it helps me understand the "gap" that SciJava Ops will fill in the image algorithm space. What I would like to see added to the document at some point is some text that helps soften the blow of the (from my perspective) unusual syntax of a SciJava Op call (i.e. |
|
@elevans thank you for taking a look.
Yeah, that's needed, although we might argue that it is better to put that discussion elsewhere. Is there not something like that in the
I don't think I can write this well, having been an opponent of this change. @hinerm or @ctrueden I would really appreciate if one of you could write this section because as proponents of this change you may be able to better convince users that it is worthwhile. |
You do not need to say And as @ctrueden wrote, this API is Java-developer-focused (e.g. programming from an IDE). We can write convenience layers on top for python/scripting for users, as needed. I vote against API-level documentation or explanation in this philosophy document. |
6d7d982 to
47c1842
Compare
|
|
||
| While it may currently seem that way, SciJava Ops is designed to *wrap* existing algorithms, not to create new ones (although you can certainly do that!) | ||
|
|
||
| To that end, SciJava Ops |
There was a problem hiding this comment.
@gselzer did you have more written that goes here? Do you have more sections planned?
There was a problem hiding this comment.
@hinerm I just wanted to write something along the lines of "SciJava exposes a rich API for declaring Ops from arbitrary sources, spanning libraries and programming languages". Sorry I forgot!
47c1842 to
32e55be
Compare
32e55be to
6d93ee1
Compare
This PR adds a new page to the documentation to describe the philosophy of Ops (i.e. "Why Ops").
I'm a bit wary of whether this document makes sense for the audience, so I'm looking for heavy critique from @ctrueden @hinerm @elevans before merging
Closes scijava/scijava#143