Cannot include square brackets in @overload method signature

[xaviershay]

While documenting the .[] method for an array-like, I wanted to do the following:

@overload vector[index]
  @param index [Integer] The index to retrieve
@overload vector[start..end]
  @param range [Range] Range of indexes to retrieve

[index] and [start..end] are stripped out in rendering. The documentation doesn't appear to preclude this.

I tried various methods of escaping (e.g. \[) but couldn't find one that works.

Is there a way to do this?

[lsegal]

There isn't a way currently but I wouldn't be opposed to adjusting the overload syntax to support it.

The current syntax is:

# @overload [](index)

You don't usually list the object name as part of the method signature, just the method name and its arguments.

[lsegal]

Closing out old issues.

I'm marking this as closed since there are no plans to implement this on my end, but if someone put together a PR I would take a look!