@itamarhaber @gkorland @MeirShpilraien @stockholmux The idea here is to take things like NOOFSETS, MAXDOCTABLESIZE and similarly named options, and document them as

MAX_DOCTABLE_SIZE, NO_OFFSETS, and so on. The older names would retain their meaning and validity for people still using the code, but we would no longer document it going forward. This should give us more flexibility in what kinds of options we expose, and actually have people read them correctly.

We should probably have a period when both syntaxes/keywords are valid and documented. If someone has an existing code base with the old syntax (maybe only weeks old), it should be somewhere so they aren't left head scratching over the documentation.

True, something like:

MAX_DOCTABLE_SIZE (deprecated: MAXDOCTABLESIZE)

My 2 cents.

I would probably do something like a general notice at the top of the doc pages that looks something like:

RediSearch is migrating to underscore concatenated keywords. This means that keywords like MAXDOCTABLESIZE will eventually be deprecated in favor of MAX_DOCTABLE_SIZE. This will increase readability.

When mentioning referencing keywords individually MAX_DOCTABLE_SIZE / MAXDOCTABLESIZEevery time. Do this for a release or two then do the MAX_DOCTABLE_SIZE (deprecated: MAXDOCTABLESIZE) thing. Then, finally, just drop MAXDOCTABLESIZE style keywords and put a replace the general notice with one that says we removed these keywords for a few versions, and finally just drop that entirely too.

It's slow and laborious, but probably the safest.

Stale issue message