rendered_markdown: Add comment explaining the use of this module.

This commit is contained in:
Rohitt Vashishtha
2020-05-21 09:47:24 +05:30
committed by Tim Abbott
parent 2efe9f7942
commit 44afcb8d64

View File

@@ -1,3 +1,14 @@
/*
rendered_markdown
This module provies a single function 'update_elements' to
update any renamed users/streams/groups etc. and other
dynamic parts of our rendered messages.
Use this module wherever some markdown rendered content
is being displayed.
*/
function get_user_id_for_mention_button(elem) {
const user_id_string = $(elem).attr('data-user-id');
// Handle legacy markdown that was rendered before we cut