chime-experiment / ch_util

CHIME utilities
https://chime-experiment.github.io/ch_util
MIT License
2 stars 3 forks source link

doc(layout): Encourage use of username with set_user #22

Closed ketiltrout closed 2 years ago

ketiltrout commented 2 years ago

The previous layout docuemntation implied you needed to pass your "real name" (whatever that is) when calling set_user. This is problematic for a few reasons:

This changes the docs to encourage using CHIMEwiki usernames when calling set_user. Usernames are much better to use because:

Note: this doesn't change any functionality: users are still able to pass the value of the user_real_name field associated with their account to this function.

(Bonus reading: Personal names are never a good thing to key a database on for multiple reasons)

anjakefala commented 2 years ago

Thanks for the documentation on the change!