Skip to content

"Ditto" documentation for another symbol #1093

Open
@grynspan

Description

@grynspan

Feature Name

"Ditto" documentation for another symbol

Description

I have a bunch of overloads of a symbol that all have exactly the same documentation. Right now, I have to manually maintain the documentation separately—if I change one symbol's documentation, I have to go find all the copies and update them too. It'd be helpful if I could write something like:

/// Flumbs a number.
///
/// - Parameters:
///    - i: The number.
///
/// - Complexity: O(_n_!) where _n_ is really big already.
///
/// Lorem ipsum dolor sit amet blah blah blah.
func f(_ i: Int) {}

/// - Same As: ``f(_i:)-1x2y3``
func f(_ i: UInt)

(Or however you'd want to spell it.)

Motivation

No response

Importance

No response

Alternatives Considered

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovements or enhancements to existing functionalitynew featureNew features or new functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions