search

abathur / ldmud-doc

A temporary repo for working on a revamp of the documentation system for http://github.com/ldmud/ldmud
0 stars 0 forks source link

Do we want to preserve prose-based history sections? #14

Closed abathur closed 8 years ago

abathur commented 9 years ago

The vast majority of our HISTORY sections are more or less lists of version numbers with brief change notes. Occasionally, however, there are much more prose-oriented history sections. This is particularly common in LPC/*. I had previously created simple history markup oriented around the list-based version before encountering the prose forms, so I'm inclined to convert/abbreviate the prose-heavy history sections to be much more list-like, unless anyone speaks up for saving them.

For reference, https://github.com/ldmud/ldmud/blob/master/doc/LPC/block#L27 contains a particularly dramatic example of long/prosaic history.

abathur commented 8 years ago

Lacking input, I'm going to go with my personal preference and say we convert the prose-oriented forms to the more easily scanned short form. If anything is really important that it needed mentioning here, it could probably be covered with a warning or obsolete admonition.