aniani/profanity
1
1
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2025-01-03 14:57:42 -05:00
Code

Fix prof_get_name_from_roster documentation

Browse Source
This commit is contained in:
Dustin Lagoy 2021-04-29 14:03:17 -04:00
parent 2350a94c44
commit 2b56e33d16
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apidocs/c/profapi.h
View File

@ -140,7 +140,7 @@ char* prof_get_current_nick(void);
/** /**
Retrieve the nickname for a given barejid if it is in the roster. 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); char* prof_get_name_from_roster(const char *barejid);

2
apidocs/python/src/prof.py
View File

@ -256,7 +256,7 @@ def get_current_nick():
def get_name_from_roster(barejid): def get_name_from_roster(barejid):
"""Retrieve a nickname from a barejid if it is in the roster. """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 :rtype: str
""" """
pass pass