Skip to content

Consider enforcing and unifying documentation for manifest fields #2993

@FroyaTheHen

Description

@FroyaTheHen

There is no connection between the TomlManifest docstrings and the web scarb documentation for the same thing. So there are couple of things to consider:

  • enforcing unifying the documentation for the two
  • enforcing writing docstings for the TomlManifest fields and its nested items as they're used in LS

Why would that make sense❓

  • To have Single Source of Truth for web doc and LS served doc.
  • To avoid having LS serving user irrelevant documentation

Though, this has low impact at the time I'm creating the task.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions