Add JSDocs for @reduxjs/prettier-config

Author: aryaemami59

packages/configs/prettier/prettier.config.mts

@@ -1,15 +1,27 @@
 import type { Config } from 'prettier'
 
+/**
+ * Prettier configuration tailored for internal Redux projects.
+ */
 export const reduxPrettierConfig: Config = {
   semi: false,
   singleQuote: true,
 }
 
+/**
+ * A function that returns {@linkcode reduxPrettierConfig}
+ * along with optional additional overrides.
+ * It's made mainly to provide intellisense and eliminate
+ * the need for manual type annotations using JSDoc comments.
+ *
+ * @param additionalOverrides - Optional additional overrides to apply to the configuration.
+ * @returns An augmented version of the default `reduxPrettierConfig`, incorporating any provided overrides.
+ */
 export const createPrettierConfig = (
-  overrides: Partial<Config> = {},
+  additionalOverrides: Partial<Config> = {},
 ): Config => ({
   ...reduxPrettierConfig,
-  ...overrides,
+  ...additionalOverrides,
 })
 
 export default reduxPrettierConfig