Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

models: Add comments documenting our name field decisions.

This commit is contained in:
Tim Abbott 2019-09-27 18:01:15 -07:00
parent 9326aa9f57
commit 2b227d6b63
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
zerver/models.py
View File

@ -763,9 +763,15 @@ class UserProfile(AbstractBaseUser, PermissionsMixin):
realm = models.ForeignKey(Realm, on_delete=CASCADE) # type: Realm
# The user's name. We prefer the model of a full_name and
# short_name over first+last because cultures vary on how many
# names one has, whether the family name is first or last, etc.
# It also allows organizations to encode a bit of non-name data in
# the "name" attribute if desired, like gender pronouns,
# graduation year, etc. The short_name attribute is currently not
# used anywhere, but the intent is that it would be used as the
# shorter familiar name for addressing the user in the UI.
full_name = models.CharField(max_length=MAX_NAME_LENGTH) # type: str
# short_name is currently unused.
short_name = models.CharField(max_length=MAX_NAME_LENGTH) # type: str
date_joined = models.DateTimeField(default=timezone_now) # type: datetime.datetime