Julia: Show similar functions in docstrings

Created on 19 Sep 2017  路  2Comments  路  Source: JuliaLang/julia

I think discoverability would be greatly enhanced, if there would be some hints at similar functions in the docstrings.
I imagine a line of See also: ...function names... which should be generated from a table of related functions automatically.

This came to my mind when looking at the docs of pop!. The functions shift! and splice! offer solutions to similar problems, but their names cannot be guessed from each other.

pop!(collection, key[, default])

  Delete and return the mapping for key if it exists in collection, otherwise return default, or
  throw an error if default is not specified.

[...]

See also: shift!(), splice!()

Of course, the wording is open for bike shedding 馃憤

doc good first issue help wanted

Most helpful comment

There is already that in a bunch of places. Feel free to make PR with more of them.

All 2 comments

There is already that in a bunch of places. Feel free to make PR with more of them.

That would be great. The manual could also be updated to suggest a standard wording for the section at https://docs.julialang.org/en/stable/manual/documentation/

Was this page helpful?
0 / 5 - 0 ratings

Related issues

i-apellaniz picture i-apellaniz  路  3Comments

TotalVerb picture TotalVerb  路  3Comments

tkoolen picture tkoolen  路  3Comments

sbromberger picture sbromberger  路  3Comments

felixrehren picture felixrehren  路  3Comments