The flip side, of course, is that having documentation separate from code often leads to the documentation becoming out of sync with the code.
What happens when someone renames or moves some code, but doesn't also move the docs? What happens if they change the implementation? Will people remember that every code change might potentially also require a change to documentation, stored somewhere else, and potentially versioned independently? - Korny On Jan 22, 2013 5:17 PM, "Rich Morin" <r...@cfcl.com> wrote: > When I discussed this approach with my spouse, she noted that > keeping documentation with source code gets in the way of a > number of issues, including internationalization. When she > worked at Apple, they had extensive discussions about this. > > -r > > -- > http://www.cfcl.com/rdm Rich Morin > http://www.cfcl.com/rdm/resume r...@cfcl.com > http://www.cfcl.com/rdm/weblog +1 650-873-7841 > > Software system design, development, and documentation > > -- > You received this message because you are subscribed to the Google > Groups "Clojure" group. > To post to this group, send email to clojure@googlegroups.com > Note that posts from new members are moderated - please be patient with > your first post. > To unsubscribe from this group, send email to > clojure+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/clojure?hl=en > -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en
