• Viktor Söderqvist's avatar
    More modules API ref formatting fixes (#8344) · 16258f21
    Viktor Söderqvist authored
    Fix broken formatting in `RM_Call` and `RM_CreateDataType`,
    `RM_SubscribeToServerEvent` (nested lists, etc. in list items).
    
    Unhide docs of `RM_LoadDataTypeFromString` and
    `RM_SaveDataTypeToString` by removing blank line between docs and
    function.
    
    Clarification added to `RM__Assert`: Recommentation to use the
    `RedisModule_Assert` macro instead.
    
    All names containing underscores (variable and macro names) are
    wrapped in backticks (if not already wrapped in backticks). This
    prevents underscore from being interpreted as italics in some
    cases.
    
    Names including a wildcard star, e.g. RM_Defrag*(), is wrapped in
    backticks (and RM replaced by RedisModule in this case). This
    prevents the * from being interpreted as an italics marker.
    
    A list item with a sublist, a paragraph and another sublist is a
    combination which seems impossible to achieve with RedCarped
    markdown, so the one occurrence of this is rewritten.
    
    Various trivial changes (typos, backticks, etc.).
    
    Ruby script:
    
    * Replace `RM_Xyz` with `RedisModule_Xyz` in docs. (RM is correct
      when refering to the C code but RedisModule is correct in the
      API docs.)
    * Automatic backquotes around C functions like `malloc()`.
    * Turn URLs into links. The link text is the URL itself.
    * Don't add backticks inside bold (**...**)
    16258f21
gendoc.rb 2.25 KB