summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexandre Erwin Ittner <alexandre@ittner.com.br>2015-01-31 19:45:03 -0200
committerAlexandre Erwin Ittner <alexandre@ittner.com.br>2015-01-31 19:45:03 -0200
commiteea415359477174aa969d8a52e7d3f9ec1b5e324 (patch)
tree29d67847ec142886e2c56a1d1e488fdd942287c5 /docs
parent33f65929e3f430e9542192d0adf98f1252a911f4 (diff)
Rename "client id" to "public key" in avatar docs and examples
Commit b8d530c9e0bbce331f22cbff7f818e49673d5bd7 and some of its parents changed the public name of "client id" to "public key". Update the avatar documentation to follow the idea.
Diffstat (limited to 'docs')
-rw-r--r--docs/Avatars.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/Avatars.md b/docs/Avatars.md
index 1dcbba96..a24c1f7c 100644
--- a/docs/Avatars.md
+++ b/docs/Avatars.md
@@ -244,7 +244,7 @@ already downloaded by other clients can be reused.
244Given the Tox data directory described in STS Draft v0.1.0: 244Given the Tox data directory described in STS Draft v0.1.0:
245 245
246 - Avatars are stored in a directory called "avatars" and named 246 - Avatars are stored in a directory called "avatars" and named
247 as "xxxxx.png", where "xxxxx" is the complete client id (but not friend 247 as "xxxxx.png", where "xxxxx" is the complete public key (but not friend
248 address!) encoded as an uppercase hexadecimal string and "png" is the 248 address!) encoded as an uppercase hexadecimal string and "png" is the
249 extension for the PNG avatar. As new image formats may be used in the 249 extension for the PNG avatar. As new image formats may be used in the
250 future, clients should ensure no other file "xxxxx.*" exists. No file 250 future, clients should ensure no other file "xxxxx.*" exists. No file
@@ -408,7 +408,7 @@ calls:
408 408
409In the previous examples, implementation of the functions to check, store 409In the previous examples, implementation of the functions to check, store
410and retrieve data from the cache were omitted for brevity. These functions 410and retrieve data from the cache were omitted for brevity. These functions
411will also need to get the friend client ID (public key) from they friend 411will also need to get the friend public key (client id) from they friend
412number and, usually, convert it from a byte string to a hexadecimal 412number and, usually, convert it from a byte string to a hexadecimal
413string. A complete, yet more complex, example is available in the file 413string. A complete, yet more complex, example is available in the file
414`testing/test_avatars.c`. 414`testing/test_avatars.c`.