Skip to content

docs generator: attrs.source() becomes str which is unhelpful #1085

@lf-

Description

@lf-

Synopsis: There are many different types of str that can be used in rules that have significant semantic meaning: sources, target selectors, and more. However, they're squashed into str at docs generation time, which is frustrating as a user, especially if the attrs in question are undocumented (something which needs improvement in the prelude overall).

Definition:

"resources": attrs.list(attrs.source(), default = []),

Result:

def command_alias(
    *,
    # ...
    platform_exe: dict[str, str] = {},
    resources: list[str] = [],
    # ...
) -> None

Web version: https://buck2.build/docs/prelude/rules/core/command_alias/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions