JuliaLang/julia

Show similar functions in docstrings

Open

#23,763 建立於 2017年9月19日

在 GitHub 查看
 (3 留言) (3 反應) (0 負責人)Julia (48,709 star) (5,773 fork)batch import
docsgood first issuehelp wanted

描述

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 👍

貢獻者指南

技術棧
無
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
The issue requests adding a 'See also' line to docstrings, linking to similar functions like shift! and splice!. To implement, one would need to identify where documentation strings are generated in Julia's base library, likely in the 'Base' module. Investigate existing doc generation code in files like 'base/docs.jl' or similar. The proposal is to create a table of related functions and automatically include references. The implementation may involve modifying the doc system to read a mapping and append cross references. No maintainer response is visible, but the idea is straightforward. Start by examining how current docstrings are produced and find where to inject the new line.
Show similar functions in docstrings · JuliaLang/julia#23763 | Good First Issue