Deduplicate Re-used Headers #354

Activity

1. avivkeller

   added this to the Web Generator Migration milestone on Jul 15, 2025
2. avivkeller

   added the

   Feature

   issue type on Jul 15, 2025
3. avivkeller

   added

   Web Generator`web`, `jsx-ast`, and `orama-db``web`, `jsx-ast`, and `orama-db`

   on Oct 12, 2025
4. moshams272 commented on Mar 19, 2026

   

   moshams272

   on Mar 19, 2026

   Last edited by moshams272

   Contributor

   More actions

   Regarding the recent UX discussion in #655:
   I know this might seem like a fairly obvious approach, but what if we visually group the overloads under a single primary heading!!

   ### `parseData`
   
   This function has multiple overloaded signatures:
   
   * **`parseData(source: string)`**
     Description for string-based parsing.
   
   * **`parseData(source: string, options: ParseOptions)`**
     Description for parsing with custom options.

   👀React with 👀1Reacted by Aviv Keller
5. moshams272 commented on Mar 19, 2026

   

   moshams272

   on Mar 19, 2026

   Contributor

   More actions

   Or do you feel this would still run into the same "information overload"!!
6. moshams272 commented on Jul 16, 2026

   

   moshams272

   on Jul 16, 2026

   Contributor

   More actions

   After brainstormming, I think that will be better to handle Overloads by adding tag like this in md files

   #### Overloads: `importModule`
   
   ##### `importModule(request, options, callback)`
   
   * `request` {string}
   * `options` {ImportModuleOptions | undefined}
   * `callback` {Function}
   * Returns: {void}
   
   ##### `importModule(request[, options])`
   
   * `request` {string}
   * `options` {ImportModuleOptions}
   * Returns: {Promise< any >}

   then make doc-kit to traverse on them and assign them like an overload boolean that helps us to not print the M for methods and do it to the name of function only to be like this:

   

   WDUT?!