Skip to content

Missing documentation for object parameters #751

@nshiab

Description

@nshiab

Hi!

In the journalism library, I have a function logBarChart with this documentation:

/**
 * Generates and logs a bar chart.
 *
 * @example
 * const data = [
 *   { category: 'A', value: 10 },
 *   { category: 'B', value: 20 },
 * ];
 * logBarChart(data, 'category', 'value');
 *
 * @param data - An array of objects representing the data to be visualized.
 * @param labels - The key in the data objects to be used for the labels.
 * @param values - The key in the data objects to be used for the values.
 * @param options - Optional configuration for the chart.
 * @param options.formatLabels - A function to format the labels. Defaults to converting the label to a string.
 * @param options.formatValues - A function to format the values. Defaults to converting the value to a string.
 * @param options.width - The width of the chart. Defaults to 40.
 *
 * @category Dataviz
 *
 */

I generated the docs with TypeDoc and published them on GitHub pages. The options are properly documented as you can see here.

Screenshot 2024-10-08 at 1 40 45 PM

I also published the library on JSR. But the options descriptions are missing, as you can see here:

Screenshot 2024-10-08 at 1 45 37 PM

Thank you for your amazing work! :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs genRelated to the documentation generationupstreamIssue is in upstream project

    Projects

    Status

    Needs Plan

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions