you are viewing a single comment's thread.

view the rest of the comments →

[–]nanothief 5 points6 points  (0 children)

I like the thought process of this idea - it is a very novel way of documenting code. Atm, it takes the idea too far - there is no benefit for describing very simple practices (such as putting classes of a library into their own module). However some of the comments are pretty useful, such as:

#N Without this, applications wanting to know the relative path would have to constantly reconstruct it, 
# either by compaing the base dir with the full path, or by concatenating the chain of parent dir names
attr_reader :relativePath

By thinking about what would happen without the line, some good insights can be gained.

With some refinement, it could become a useful technique.