schema documentation

[S Ahmed]

We all hate documentation, and the best documentation is readable code.

Having said that, what steps do you guys take to have your redis schema up to date?

Do you just keep all your calls grouped together, or do you have comments in your code that describe the layout of hashes, sets, etc?

[Josiah Carlson]

I will usually describe structures in the context of the collection of
API functions that use them (typically a cluster of functions in a
module, or rarely, methods on a class), if the structures are not
obvious.

- Josiah

> --
> You received this message because you are subscribed to the Google Groups
> "Redis DB" group.
> To post to this group, send email to redi...@googlegroups.com.
> To unsubscribe from this group, send email to
> redis-db+u...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/redis-db?hl=en.

[M. Edward (Ed) Borasky]

On Wed, Nov 14, 2012 at 1:47 PM, S Ahmed <sahme...@gmail.com> wrote:

> We all hate documentation, and the best documentation is readable code.

We don't *all* hate documentation!

>
> Having said that, what steps do you guys take to have your redis schema up
> to date?
>
> Do you just keep all your calls grouped together, or do you have comments in
> your code that describe the layout of hashes, sets, etc?
>
>

> --
> You received this message because you are subscribed to the Google Groups
> "Redis DB" group.
> To post to this group, send email to redi...@googlegroups.com.
> To unsubscribe from this group, send email to
> redis-db+u...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/redis-db?hl=en.

I'm a firm believer in literate programming and reproducible research.
Really, unless you're doing FORTH code at the command line in 64 KB of
RAM, you can do better than just comments and "understandable,
readable code".

--
Twitter: http://twitter.com/znmeb; Computational Journalism Publishers
Workbench: http://znmeb.github.com/Computational-Journalism-Publishers-Workbench/

How the Hell can the lion sleep with all those people singing "A weem
oh way!" at the top of their lungs?