Skip to content

Feature Request: Support markdownlint-compatible field types #1689

@Stausssi

Description

@Stausssi

I'm currently on sphinx-needs 6.3.0 and stumbled upon a problem when using markdownlint in combination with MySt colon fences:

I have a custom needs_extra_options, e.g. with schema validation for emails:

NeedExtraOption(
    name="deciders",
    description="People involved in and ultimately deciding a design decision.",
    schema={
        "type": "array",
        "items": {"type": "string", "format": "email"},
        "minItems": 1,
    },
)

Unfortunately, "format": "email" is incompatible with markdownlints MD034 rule as it also want's emails wrapped in <email@example.com>:

ERROR: Need 'DD_FOO_BAR' has schema violations:
  Severity:       violation
  Field:          deciders.0
  Need path:      DD_FOO_BAR
  Schema path:    extra_options > schema > properties > deciders > items > format
  Schema message: "<email@example.com" is not a "email" [sn_schema_violation.extra_option_fail]

Is this maybe even a feature request in the MySt parser itself?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions