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
(217)
Issues Repositories Search
Open Issues | Closed Issues | All Issues | Sign in with your Google Account to create issues and add comments

Issue 1186: rowchooser docs

Can't Edit
Can't Publish+Mail
Start Review
Created:
17 years, 7 months ago by jss
Modified:
2 years, 2 months ago
Reviewers:
cls
Base URL:
https://coders.de/svn/mod/trunk/src/Components/base
Visibility:
Public.

Patch Set 1 #

Created: 17 years, 7 months ago
Download [raw] [tar.bz2]
Unified diffs Side-by-side diffs Delta from patch set Stats (+56 lines, -0 lines) Patch
RowChooser.h View 1 chunk +20 lines, -0 lines 0 comments Download
RowChooser.cpp View 1 chunk +20 lines, -0 lines 0 comments Download
RowChooser.xml View 1 chunk +16 lines, -0 lines 14 comments Download
Total messages: 3
|
jss
http://codereview.appspot.com/1186/diff/1/2 File RowChooser.xml (right): http://codereview.appspot.com/1186/diff/1/2#newcode3 Line 3: <summary> Gives back row from matrix at certain ...
17 years, 7 months ago (2008年05月27日 19:01:55 UTC) #1
http://codereview.appspot.com/1186/diff/1/2
File RowChooser.xml (right):
http://codereview.appspot.com/1186/diff/1/2#newcode3
Line 3: <summary> Gives back row from matrix at certain index </summary>
/Returns/ is the word. The index maybe /certain/, but it needs to be
/specified/.
http://codereview.appspot.com/1186/diff/1/2#newcode4
Line 4: <description> </description>
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.
http://codereview.appspot.com/1186/diff/1/2#newcode7
Line 7: 1xM matrix consisting of the values from the NxM input matrix at the row
of the specified index.
its worth noting that the type is equal to the type of the input matrix.
http://codereview.appspot.com/1186/diff/1/2#newcode10
Line 10: Matrix of any sort.
not that arbitrary.
we need to impose strict limits on its dimensionality and number of channels.
http://codereview.appspot.com/1186/diff/1/2#newcode13
Line 13: 1x1 matrix specifing the index (int).
int? nope. anything.
http://codereview.appspot.com/1186/diff/1/2#newcode16
Line 16: </component>
no, we dont reach that doc quality everywhere. but its a start :)
Sign in to reply to this message.
jss
http://codereview.appspot.com/1186/diff/1/2 File RowChooser.xml (right): http://codereview.appspot.com/1186/diff/1/2#newcode2 Line 2: <component name="Resize" authors="cls" version="1.0"> the name :)
17 years, 7 months ago (2008年05月27日 19:08:12 UTC) #2
http://codereview.appspot.com/1186/diff/1/2
File RowChooser.xml (right):
http://codereview.appspot.com/1186/diff/1/2#newcode2
Line 2: <component name="Resize" authors="cls" version="1.0">
the name :)
Sign in to reply to this message.
cls
http://codereview.appspot.com/1186/diff/1/2 File RowChooser.xml (right): http://codereview.appspot.com/1186/diff/1/2#newcode2 Line 2: <component name="Resize" authors="cls" version="1.0"> On 2008年05月27日 19:08:12, jss ...
17 years, 7 months ago (2008年05月27日 20:58:48 UTC) #3
http://codereview.appspot.com/1186/diff/1/2
File RowChooser.xml (right):
http://codereview.appspot.com/1186/diff/1/2#newcode2
Line 2: <component name="Resize" authors="cls" version="1.0">
On 2008年05月27日 19:08:12, jss wrote:
> the name :)
ack
http://codereview.appspot.com/1186/diff/1/2#newcode3
Line 3: <summary> Gives back row from matrix at certain index </summary>
On 2008年05月27日 19:01:56, jss wrote:
> /Returns/ is the word. The index maybe /certain/, but it needs to be
> /specified/.
ack
http://codereview.appspot.com/1186/diff/1/2#newcode4
Line 4: <description> </description>
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.
http://codereview.appspot.com/1186/diff/1/2#newcode7
Line 7: 1xM matrix consisting of the values from the NxM input matrix at the row
of the specified index.
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."?
http://codereview.appspot.com/1186/diff/1/2#newcode10
Line 10: Matrix of any sort.
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?
http://codereview.appspot.com/1186/diff/1/2#newcode13
Line 13: 1x1 matrix specifing the index (int).
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.
http://codereview.appspot.com/1186/diff/1/2#newcode16
Line 16: </component>
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.
Sign in to reply to this message.
|
Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b

AltStyle によって変換されたページ (->オリジナル) /