Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use human-readable matrices in documentation examples #33

Closed
patrickbarks opened this issue Sep 11, 2018 · 1 comment
Closed

Use human-readable matrices in documentation examples #33

patrickbarks opened this issue Sep 11, 2018 · 1 comment

Comments

@patrickbarks
Copy link
Collaborator

I propose using a consistent, human-readable format when creating matrices in the @example section of Rage functions, e.g.

Format 1

matU <- rbind(c(  0,   0,    0,   0),
              c(0.1, 0.1,  0.1,   0),
              c(  0, 0.3,  0.3, 0.1),
              c(  0,   0,  0.2, 0.1))

Format 2

matU <- rbind(c(0.0, 0.0,  0.0, 0.0),
              c(0.1, 0.1,  0.1, 0.0),
              c(0.0, 0.3,  0.3, 0.1),
              c(0.0, 0.0,  0.2, 0.1))

I think Format 1 is slightly easier to read in the R documentation browser. Thoughts?

@jonesor
Copy link
Owner

jonesor commented Sep 12, 2018

Good point. I find Formats super clear, but I marginally prefer Format 2.

@jonesor jonesor closed this as completed Sep 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants