Skip to content

intentionallyNotDocumented Option #2863

Closed
Closed
@Zamiell

Description

@Zamiell

Problem

Sometimes, we need to intentionally ignore some non-documented fields. Here's an example of a false-positive:

import { $ } from "execa";

/** Alias for `$({ stdout: "pipe", stderr: "pipe" })` from the `execa` library. */
export const $q = $({ stdout: "pipe", stderr: "pipe" });

Discord cross link: https://discord.com/channels/508357248330760243/829307039447515176/1341981378581106771

Suggested Solution

Implement a "intentionallyNotDocumented" option.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions