RowChooser.xml - Issue 1186: rowchooser docs

Keyboard Shortcuts

File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view
Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue
Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Rietveld Code Review Tool

Help | Bug tracker | Discussion group | Source code | Sign in

(347)

Issues Repositories Search

Open Issues | Closed Issues | All Issues | Sign in with your Google Account to create issues and add comments

Unified Diff: RowChooser.xml

Issue 1186: rowchooser docs Base URL: https://coders.de/svn/mod/trunk/src/Components/base

Patch Set: Created 17 years, 7 months ago

Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: RowChooser.xml

===================================================================

--- RowChooser.xml (revision 0)

+++ RowChooser.xml (revision 1997)

@@ -0,0 +1,16 @@

+<?xml version="1.0" encoding="iso-8859-1" ?>

+<component name="Resize" authors="cls" version="1.0">

jss 2008年05月27日 19:08:12 the name :)

the name :)

cls 2008年05月27日 20:58:49 ack

On 2008年05月27日 19:08:12, jss wrote: > the name :)

ack

+ <summary> Gives back row from matrix at certain index </summary>

jss 2008年05月27日 19:01:56 /Returns/ is the word. The index maybe /certain/,

/Returns/ is the word. The index maybe /certain/, but it needs to be /specified/.

cls 2008年05月27日 20:58:49 ack

On 2008年05月27日 19:01:56, jss wrote: > /Returns/ is the word. The index maybe /certain/, but it needs to be > /specified/.

ack

+ <description> </description>

jss 2008年05月27日 19:01:56 you really want to move the description of what th

you really want to move the description of what the component actually does (return a row vector from a 2d matrix) in here, and only specify possible matrix layouts in the method descriptions.

cls 2008年05月27日 20:58:49 ack - check my latest checkin... I'm not sure if i

On 2008年05月27日 19:01:56, jss wrote: > you really want to move the description of what the component actually does > (return a row vector from a 2d matrix) in here, and only specify possible matrix > layouts in the method descriptions. >

ack - check my latest checkin... I'm not sure if it is allright by now.

+ <header>

+ <out name="row">

+ 1xM matrix consisting of the values from the NxM input matrix at the row of the specified index.

jss 2008年05月27日 19:01:56 its worth noting that the type is equal to the typ

its worth noting that the type is equal to the type of the input matrix.

cls 2008年05月27日 20:58:49 What would that note look like, "Notice, the 1xM m

On 2008年05月27日 19:01:56, jss wrote: > its worth noting that the type is equal to the type of the input matrix.

What would that note look like, "Notice, the 1xM matrix is of the same data type as the input matrix."?

+ </out>

+ <in name="matrix">

+ Matrix of any sort.

jss 2008年05月27日 19:01:56 not that arbitrary. we need to impose strict limit

not that arbitrary. we need to impose strict limits on its dimensionality and number of channels.

cls 2008年05月27日 20:58:49 What kind of limits would that be? As many columns

On 2008年05月27日 19:01:56, jss wrote: > not that arbitrary. > we need to impose strict limits on its dimensionality and number of channels.

What kind of limits would that be? As many columns as we have percentiles? Guess not, as we would have to check the graph for that parameter. Instead, I guess, we will come back to practical limits? When it comes to channels: We have to have only one channel, I guess. True?

+ </in>

+ <in name="index">

+ 1x1 matrix specifing the index (int).

jss 2008年05月27日 19:01:56 int? nope. anything.

int? nope. anything.

cls 2008年05月27日 20:58:49 So I just write "1x1 matrix specifing the index."

On 2008年05月27日 19:01:56, jss wrote: > int? nope. anything.

So I just write "1x1 matrix specifing the index." or am I supposed to further explain "Matrix can convey any data type."? Anyway, taking any data type is possible, cuz we're gonna check type inside the component and throw some exceptions when an invalid type was passed.

+ </in>

+ </header>

+</component>

jss 2008年05月27日 19:01:56 no, we dont reach that doc quality everywhere. but

no, we dont reach that doc quality everywhere. but its a start :)

cls 2008年05月27日 20:58:49 I was skipping through quite some components and h

On 2008年05月27日 19:01:56, jss wrote: > no, we dont reach that doc quality everywhere. but its a start :)

I was skipping through quite some components and have rarely seen such an explicit documentation - I thought. On the one hand, it was for that reason why had trouble finding a good heuristic for documenting, and on the other hand, got the impression that documenting in jamf is not supposed to be that explicit.

« no previous file with comments | « RowChooser.cpp ('k') | no next file » | no next file with comments »

RSS Feeds Recent Issues | This issue

This is Rietveld f62528b