Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Ditto" documentation for another symbol #1093

Open
grynspan opened this issue Nov 11, 2024 · 0 comments
Open

"Ditto" documentation for another symbol #1093

grynspan opened this issue Nov 11, 2024 · 0 comments
Labels
enhancement Improvements or enhancements to existing functionality new feature New features or new functionality

Comments

@grynspan
Copy link

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

@grynspan grynspan added enhancement Improvements or enhancements to existing functionality new feature New features or new functionality labels Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or enhancements to existing functionality new feature New features or new functionality
Projects
None yet
Development

No branches or pull requests

1 participant