doc(layout): Encourage use of username with set_user #22
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
user_real_name
field (which is what's being matched here)user_real_name
field is typically populated by sysadmins when creating a wiki account. It's available and can be changed by users in the wiki profile page, but most wiki users don't change it nor do they even know what the value has been set to.user_real_name
be unique.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 associatedwith their account to this function.
(Bonus reading: Personal names are never a good thing to key a database on for multiple reasons)