Add alternate names/tags to function docblocks for the LSP to pickup / people to find by find-all

[inoas]

See gleam-lang/stdlib#307 (comment)

If above gets merged or not does not matter for the sake of this argument:

Users onboarding from other languages may be used to certain nomenclature.
For instance it took me a while to find a map() function. People may be looking for abs() etc.

Would it be nice if when typing those functions the LSP could scan the docblock for a tag of alternate names?

Tagged @NicklasXYZ

[lpil]

I like this idea a lot. We should also think about what the syntax might be like

[inoas]

/// Doc block here
///
@alt_names: abs, absolute
pub fn absolute_value(number x:Int) -> Int {
  todo
}

/// I don’t like this
///
pub fn absolute_value/absolute/abs(number x:Int) -> Int {
  todo
}

/// Neither this really
///
pub fn absolute_value(number x:Int) -> Int {
  todo
}, abs, absolute

[lpil]

That first one looks nicest to me. I imagine we could have other attributes too such as ones for depredation

[inoas]

Deprecation? Yes <3

[inoas]

@deprecated
@deprecated_use: foo

[inoas]

Ref: gleam-lang/stdlib#302 (comment)
We could also have @also_see module.function if thats beneficial enough.

[inoas-nbw]

@aliases to_int
pub fn truncate(...

@aliases abs
pub fn absolute_value(...

@alias count
pub fn length(...

@aliases distinct
pub fn unique(...

[inoas]

Could include an optional description why that alias exists.
See for example: gleam-lang/stdlib#599 (comment)