Suppose I have a project that is written in a literate format (e.g., emacs org-mode), and I would like to have that code reviewed. What is the preferred way to post the code?
Some options that come immediately to mind are:
- Preserve the literate form of the program. It depends on the project, but there's likely to be quite a bit of prose surrounding the actual code. Even very small libraries may be relatively long when expressed in literate form. This makes the code clear, but is not necessarily concise.
- Post the extracted code. This keeps the post short, but is not necessarily clear.
- Post the extracted code, possibly including select portions of the prose, and link to the full literate version -- preferably a specific version under revision control.
However, I'm sure there are other options that are worth considering as well.
Also, it could very well be the case that there is no single approach that fits in all situations. If that's the case, what are some heuristics for choosing the right approach?