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

Show "See Also" links for all functions #1746

Closed
ckoparkar opened this issue May 12, 2016 · 2 comments
Closed

Show "See Also" links for all functions #1746

ckoparkar opened this issue May 12, 2016 · 2 comments

Comments

@ckoparkar
Copy link
Contributor

Right now (#1736), the middleware has See Also information only for clojure.core.
But it would be good to be able to show the links for all namespaces. Parsing the docstring and generating links from there is one way to do it. So, the docstring would look something like,

Returns a lazy sequence of the items in coll for which
(pred item) returns true. pred must be free of side-effects.
Returns a transducer when no collection is provided.

See also: `clojure.core/remove', `clojure.core/keep', `user-ns/user-fn'

So we just need to collect all the ``'` pairs and replace them with buttons which would lookup the corresponding documentation.

Relevant discussion here

@Malabarba
Copy link
Member

Two things:

  1. We should use clojure.core/remove, not ``clojure.core/remove'`.
  2. We should try to linkify any occurrence of function-in-quotes in the docstring, not just the "see also:" links.

@ckoparkar
Copy link
Contributor Author

Fixed by #1750.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants