Skip to content

Documents RM_Call's fmt#5448

Merged
oranagra merged 5 commits intoredis:unstablefrom
itamarhaber:rm_call_fmt
Sep 9, 2020
Merged

Documents RM_Call's fmt#5448
oranagra merged 5 commits intoredis:unstablefrom
itamarhaber:rm_call_fmt

Conversation

@itamarhaber
Copy link
Member

I could swear something like this used to be there, but for the life of me, I can't find it. Anyway, this is needed so the API's documentation is more complete.

@oranagra
Copy link
Member

oranagra commented Sep 5, 2020

@itamarhaber these days the doc refers to https://redis.io/topics/modules-intro for the list of format.
i actually feel that it's better that the header is self-sufficient.
if you also think so, this PR needs to be updated (it's contents seems outdated).

@itamarhaber itamarhaber requested a review from oranagra September 5, 2020 14:45
@itamarhaber
Copy link
Member Author

@oranagra updated - please review.

@oranagra
Copy link
Member

oranagra commented Sep 5, 2020

@itamarhaber please rebase. i don't understand how come github doesn't show conflicts.

oranagra
oranagra previously approved these changes Sep 5, 2020
@oranagra
Copy link
Member

oranagra commented Sep 5, 2020

ok. i understand why it doesn't show conflicts.
seems ok, but considering that the usage of this command it a bit complicated, maybe a simple short example would be helpful too?
something like:

RedisModule_Call(ctx,"INCRBY","sc",argv[1],"10");

or a longer one like the top one in the referred docs:?

reply = RedisModule_Call(ctx,"INCRBY","sc",argv[1],"10");
if (RedisModule_CallReplyType(reply) == REDISMODULE_REPLY_INTEGER) {
    long long myval = RedisModule_CallReplyInteger(reply);
    /* Do something with myval. */
}

@oranagra oranagra added the state:to-be-merged The PR should be merged soon, even if not yet ready, this is used so that it won't be forgotten label Sep 5, 2020
@itamarhaber
Copy link
Member Author

Added as suggested.

@oranagra oranagra merged commit ce15620 into redis:unstable Sep 9, 2020
oranagra added a commit that referenced this pull request Sep 10, 2020
Improve RM_Call inline documentation about the fmt argument
so that we don't completely depend on the web docs.

Co-authored-by: Oran Agra <[email protected]>
(cherry picked from commit ce15620)
JackieXie168 pushed a commit to JackieXie168/redis that referenced this pull request Nov 4, 2020
Improve RM_Call inline documentation about the fmt argument
so that we don't completely depend on the web docs.

Co-authored-by: Oran Agra <[email protected]>
jschmieg pushed a commit to memKeyDB/memKeyDB that referenced this pull request Nov 6, 2020
Improve RM_Call inline documentation about the fmt argument
so that we don't completely depend on the web docs.

Co-authored-by: Oran Agra <[email protected]>
(cherry picked from commit ce15620)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

class:text docs and typos state:to-be-merged The PR should be merged soon, even if not yet ready, this is used so that it won't be forgotten

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants