Add docs

comic · Oct 14, 2024 · 5c04f63 · 5c04f63
1 parent 27cab7e
commit 5c04f63
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/app/grandchallenge/core/static/js/markdownx_full_page.js b/app/grandchallenge/core/static/js/markdownx_full_page.js
@@ -1,5 +1,6 @@
-$("document").ready(() => {
-    // Sync the height of the preview element to the height of the editor element.
+// Sync the height of the preview element to the height of the editor element.
+// This lets the user adjust the height of both elements by resizing the editor.
+$(document).ready(() => {
     const ELEMENTS = document.getElementsByClassName("markdownx");
     Object.values(ELEMENTS).map(element => {
         const editor = element.querySelector(".markdownx-editor");

diff --git a/app/grandchallenge/core/widgets.py b/app/grandchallenge/core/widgets.py
@@ -97,6 +97,8 @@ def media(self):
 
 
 class MarkdownEditorFullPageWidget(MarkdownEditorInlineWidget):
+    """Customized MarkdownX widget with side-by-side panes."""
+
     template_name = "markdownx/full_page_widget.html"
 
     class Media: