diff options
author | Dustin Lagoy <dustin@lagoy.org> | 2021-04-29 14:03:17 -0400 |
---|---|---|
committer | Dustin Lagoy <dustin@lagoy.org> | 2021-04-29 14:03:17 -0400 |
commit | 2b56e33d164bfa5ae41b4f598ca3e3ea54dcd51c (patch) | |
tree | e41b73ad127bb5c3967cb133a715643b6e5e64e4 | |
parent | 2350a94c4411635f15173ec9c7964ea89e3fb2b1 (diff) | |
download | profani-tty-2b56e33d164bfa5ae41b4f598ca3e3ea54dcd51c.tar.gz |
Fix prof_get_name_from_roster documentation
-rw-r--r-- | apidocs/c/profapi.h | 2 | ||||
-rw-r--r-- | apidocs/python/src/prof.py | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h index 04da8a4e..4d61ca7d 100644 --- a/apidocs/c/profapi.h +++ b/apidocs/c/profapi.h @@ -140,7 +140,7 @@ char* prof_get_current_nick(void); /** Retrieve the nickname for a given barejid if it is in the roster. -@return the users nickname e.g. "eddie", or NULLL if the barejid is not in the roster. +@return the users nickname e.g. "eddie", or the input barejid if it is not in the roster. */ char* prof_get_name_from_roster(const char *barejid); diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py index eafaeeb7..1b926b36 100644 --- a/apidocs/python/src/prof.py +++ b/apidocs/python/src/prof.py @@ -256,7 +256,7 @@ def get_current_nick(): def get_name_from_roster(barejid): """Retrieve a nickname from a barejid if it is in the roster. - :return: the users nickname e.g. ``"eddie"``, or ``None`` if the barejid is not in the roster. + :return: the users nickname e.g. "eddie", or the input barejid if it is not in the roster. :rtype: str """ pass |