StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

POWhat parts of a Ruby-on-Rails application (with reasonably expressive unit tests) should have RDoc?
primarykey
Id
2322146
data
AcceptedAnswerId
0
AnswerCount
3
ClosedDate
2018-01-02T15:09:16.737
CommentCount
0
CommunityOwnedDate
CreationDate
2010-02-23T22:10:07.413
FavoriteCount
0
LastActivityDate
2010-02-26T16:02:01.847
LastEditDate
2010-02-24T05:17:14.967
LastEditorUserId
225859
OwnerUserId
225859
ParentId
0
PostTypeId
1
Score
0
ViewCount
328
LastEditorDisplayName
text
Body
<p>I'm developing an open-source web application on top of Rails. I'd like to make my code as easy to understand and modify as possible. I'm test-driving my development with unit tests, so much of the code is "documented" through test cases (what each controller action expects as input, what instance variables are set for output, how helpers should be called, what business logic the models incorporate, etc.). And on top of that, Rails' conventions should make a lot of documentation unnecessary where my code conforms to them.</p> <p>So, where's the balance between having a well-documented Rails application and trying to obey Don't Repeat Yourself? Are there any good blogs or articles with guidance on what (RDoc) documentation is really helpful in a Rails app, and what's just waste?</p>
Tags
<ruby-on-rails><documentation><rdoc>
Title
What parts of a Ruby-on-Rails application (with reasonably expressive unit tests) should have RDoc?
singulars
PostAcceptedAnswerId
1. This table or related slice is empty.
PostParentId
1. This table or related slice is empty.
PostTypePostTypeId
1. PTQuestion
UserLastEditorUserId
1. USGlen E. Ivey
UserOwnerUserId
1. USGlen E. Ivey
plurals
PostLinksPostIdRelatedPostId
1. This table or related slice is empty.
PostLinksRelatedPostIdPostId
1. This table or related slice is empty.
PostsAcceptedAnswerId
1. This table or related slice is empty.
PostsParentIdCreationDate
1. PO
  singulars
  PostTypePostTypeId
  PTAnswer
2. PO
  singulars
  PostTypePostTypeId
  PTAnswer
3. PO
  singulars
  PostTypePostTypeId
  PTAnswer
VotesPostIdCreationDate
1. VO
  singulars
  PostPostId
  POWhat parts of a Ruby-on-Rails application (with reasonably expressive unit tests) should have RDoc?
  UserUserId
  This table or related slice is empty.
  VoteTypeVoteTypeId
  VTUpMod
CommentsPostId
1. This table or related slice is empty.

Querying!

Guidance

A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.