Update naming and add comment (#10388)

guardian · Jan 29, 2024 · f50e88f · f50e88f
1 parent 24dd18e
commit f50e88f
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/dotcom-rendering/src/components/Discussion.tsx b/dotcom-rendering/src/components/Discussion.tsx
@@ -70,7 +70,11 @@ const commentIdFromUrl = () => {
 	return parseInt(commentId, 10);
 };
 
-const remapFilters = (
+/**
+ * If a permalink is used and the threading is set to collapsed, this function remaps the threading filter to expanded.
+ * We do this to ensure that threads are expanded in the UI while respecting the user's local preference.
+ */
+const remapToValidFilters = (
 	filters: FilterOptions,
 	hashCommentId: number | undefined,
 ) => {
@@ -129,7 +133,7 @@ export const Discussion = ({
 			});
 	}, [filters, commentPage, shortUrlId]);
 
-	const validFilters = remapFilters(filters, hashCommentId);
+	const validFilters = remapToValidFilters(filters, hashCommentId);
 
 	useEffect(() => {
 		rememberFilters(filters);