Skip to content

Bug report (PR#7341)

3 messages · dan@bolser.co.uk, Martin Maechler, Dan Bolser

Original
dan@bolser.co.uk
# 
Full_Name: Dan B
Version: na
OS: na
Submission from: (NULL) (80.6.127.185)


I can't log into the bug tracker (I can't find where to register / login).


In this way I can't add the following context diff (hopefully in the right
order) for my changes to the matrix.Rd...

Hmm... I guess this should be a separate report anyway...

The first diff explains how the dimnames list should work, and the second diff
gives an example of using the dimnames list. (no equivelent example exists, and
where better than the matrix man page to show this off).

*** ./matrix.Rd 2004-11-03 14:44:13.000000000 +0000
--- Original/matrix.Rd  2004-11-03 14:48:40.000000000 +0000
***************
*** 28,32 ****
      filled by rows.}
    \item{dimnames}{A \code{\link{dimnames}} attribute for the matrix: a
!     \code{list} of length 2.}
    \item{x}{an \R object.}
  }
--- 28,32 ----
      filled by rows.}
    \item{dimnames}{A \code{\link{dimnames}} attribute for the matrix: a
!     \code{list} of length 2 giving the row and column names respectivly.}
    \item{x}{an \R object.}
  }
***************
*** 63,66 ****
--- 63,77 ----
  warpbreaks[1:10,]
  as.matrix(warpbreaks[1:10,]) #using as.matrix.data.frame(.) method
+
+ # Example of setting row and column names
+ data <- matrix(c(16522,34057,40949,
+                  19924,46032,55185),
+                nrow=2, ncol=3,
+                byrow=TRUE,
+                dimnames = list(
+                  c('PDB','MSD'),
+                  c('Entry','Chain','Domain')
+                  )
+                )
  }
  \keyword{array}
Martin Maechler
# 
dan> Full_Name: Dan B Version: na OS: na Submission from:
    dan> (NULL) (80.6.127.185)


    dan> I can't log into the bug tracker (I can't find where to
    dan> register / login).

[that's not what you should do. 
 Have you read on this in the FAQ or  help(bug.report) ?
 Please, please, do.
]

    dan> In this way I can't add the following context diff
    dan> (hopefully in the right order) for my changes to the
    dan> matrix.Rd...

    dan> Hmm... I guess this should be a separate report
    dan> anyway...

No, this is really not a bug report __AT ALL__

You had all this long discussion about how the documentation 
can/could/should/{is_hard_to} be improved  and end up sending
a *bug report* ?
Really!

Whereas I value your contribution for improving the matrix help
page -- and I do think both changes are worthwhile ---
there is no bug, and hence a bug report is *WRONG*!

Sending this to R-devel [instead! - not automagically via the
bug report] would have been perfectly fine and helpful...

    dan> The first diff explains how the dimnames list should
    dan> work, and the second diff gives an example of using the
    dan> dimnames list. (no equivelent example exists, and where
    dan> better than the matrix man page to show this off).

agreed.

I'll put in a version of your proposed improvement,
but please do try more to understand what's appropriate for bug
reports.

Regards,
Martin Maechler, ETH Zurich
Dan Bolser
#
On Fri, 5 Nov 2004, Martin Maechler wrote:

            

      
      
      
    

        
OK, I just wanted to post a 'follow up' to the original 'bug'.

            

      
      
      
    

        
Sorry. This is probably the cause of all the problems.

I know this isn't a 'bug' in the strict sense, but nither are the
'wishlist' entries on the bugs pages. I thought a bug report was a good
place to log these requests, so that they didn't get 'dropped' in the
system (i.e. "I thought you were catching that" - "Oh I thought *you* were
catching that") 

The bug report could be debated / altered as any bug is.

What classifies as a 'documentation bug'? A piece of documentation that
crashes my OS? (or my brain? ;)

Anyway, I know better now.

Thanks very much for the information,
All the best,
Dan.