Skip to content

[SR-16072] Stop using a "placeholder abstract" in DocumentationNode #168

@QuietMisdreavus

Description

@QuietMisdreavus
Previous ID SR-16072
Radar rdar://90982942
Original Reporter @QuietMisdreavus
Type Improvement
Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Improvement
Assignee None
Priority Medium

md5: 8c315d981b6d5e65d33a82941834812a

Issue Description:

When a DocumentationNode is first initialized, it gets a basic set of data loaded in. Some of the data is left blank and loaded in from symbol data later on. In the initializer, the abstractSectionVariants gets populated with a "Placeholder Abstract". This placeholder is unnecessary; it will get overwritten by whatever the symbol information has, even if it's blank. Swift-DocC and Swift-DocC-Render can handle blank abstracts, so this placeholder should instead just be .empty to avoid the useless allocation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovements or enhancements to existing functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions