{"action":"created","comment":{"url":"https://api.github.com/repos/clojure-emacs/cider/pulls/comments/68057978","id":68057978,"diff_hunk":"@@ -140,6 +124,40 @@ More details can be found [here](https://github.com/clojure-emacs/cider/issues/9\n (setq cider-filter-regexps '(\".*nrepl\"))\n ```\n \n+## Configuring eldoc\n+\n+* Enable `eldoc` in Clojure buffers:\n+\n+```el\n+(add-hook 'cider-mode-hook #'eldoc-mode)\n+```\n+\n+![Eldoc](images/eldoc.png)\n+\n+* CIDER also would show the eldoc for the symbol at point. So in (map inc ...)\n+when the cursor is over inc its eldoc would be displayed. You can turn off this\n+behaviour by:\n+\n+```el\n+(setq cider-eldoc-display-for-symbol-at-point nil)\n+```\n+\n+* CIDER respects the value of `eldoc-echo-area-use-multiline-p` when\n+displaying documentation in the minibuffer. You can customize this variable to change\n+its behaviour.\n+\n+| eldoc-echo-area-use-multiline-p | Behaviour |\n+| ------------- | ------------- |\n+| `t`  | Never attempt to truncate messages. Complete symbol name and function arglist or variable documentation will be displayed even if echo area must be resized to fit.|\n+| `nil`  | Messages are always truncated to fit in a single line of display in the echo area.  |\n+| `truncate-sym-name-if-fit` or anything non-nil | Symbol name may be truncated if it will enable the function arglist or documentation string to fit on a single line. Otherwise, behavior is just like `t` case. |\n+\n+CIDER's current behaviour can be achieved by;","path":"doc/configuration.md","position":55,"original_position":55,"commit_id":"4a08a7e24704729c0176ae77181ccb6ae0924ae8","original_commit_id":"4a08a7e24704729c0176ae77181ccb6ae0924ae8","user":{"login":"bbatsov","id":103882,"avatar_url":"https://avatars.githubusercontent.com/u/103882?v=3","gravatar_id":"","url":"https://api.github.com/users/bbatsov","html_url":"https://github.com/bbatsov","followers_url":"https://api.github.com/users/bbatsov/followers","following_url":"https://api.github.com/users/bbatsov/following{/other_user}","gists_url":"https://api.github.com/users/bbatsov/gists{/gist_id}","starred_url":"https://api.github.com/users/bbatsov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bbatsov/subscriptions","organizations_url":"https://api.github.com/users/bbatsov/orgs","repos_url":"https://api.github.com/users/bbatsov/repos","events_url":"https://api.github.com/users/bbatsov/events{/privacy}","received_events_url":"https://api.github.com/users/bbatsov/received_events","type":"User","site_admin":false},"body":"I don't understand this line.","created_at":"2016-06-22T14:02:19Z","updated_at":"2016-06-22T14:02:19Z","html_url":"https://github.com/clojure-emacs/cider/pull/1785#discussion_r68057978","pull_request_url":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785","_links":{"self":{"href":"https://api.github.com/repos/clojure-emacs/cider/pulls/comments/68057978"},"html":{"href":"https://github.com/clojure-emacs/cider/pull/1785#discussion_r68057978"},"pull_request":{"href":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785"}}},"pull_request":{"url":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785","id":73759534,"html_url":"https://github.com/clojure-emacs/cider/pull/1785","diff_url":"https://github.com/clojure-emacs/cider/pull/1785.diff","patch_url":"https://github.com/clojure-emacs/cider/pull/1785.patch","issue_url":"https://api.github.com/repos/clojure-emacs/cider/issues/1785","number":1785,"state":"open","locked":false,"title":"Feature/multiline eldoc","user":{"login":"cskksc","id":5201497,"avatar_url":"https://avatars.githubusercontent.com/u/5201497?v=3","gravatar_id":"","url":"https://api.github.com/users/cskksc","html_url":"https://github.com/cskksc","followers_url":"https://api.github.com/users/cskksc/followers","following_url":"https://api.github.com/users/cskksc/following{/other_user}","gists_url":"https://api.github.com/users/cskksc/gists{/gist_id}","starred_url":"https://api.github.com/users/cskksc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cskksc/subscriptions","organizations_url":"https://api.github.com/users/cskksc/orgs","repos_url":"https://api.github.com/users/cskksc/repos","events_url":"https://api.github.com/users/cskksc/events{/privacy}","received_events_url":"https://api.github.com/users/cskksc/received_events","type":"User","site_admin":false},"body":"For #1782. We now consider the value of `eldoc-echo-area-use-multiline-p` while formatting the docstring for a var. It's semantics are;\r\n\r\n| eldoc-echo-area-use-multiline-p | Behaviour |\r\n| ------------- | ------------- |\r\n| `t`  | never attempt to truncate messages  |\r\n| `nil`  | messages are always truncated to fit in a single line  |\r\n| `truncate-sym-name-if-fit` or anything else | symbol name may be truncated if it will enable the function arglist or documentation string to fit on a single line |\r\n\r\nThis PR does not implement the last case. Any ideas on how to ? We could use `cider-abbreviate-ns`, or `cider-last-ns-segment`. But I'm not sure if truncating the name this way is right. The name may be more important than eldoc.\r\n\r\n- [x] The commits are consistent with our [contribution guidelines][1]\r\n- [x] You've added tests (if possible) to cover your change(s)\r\n- [x] All tests are passing (`make test`)\r\n- [x] The new code is not generating bytecode or `M-x checkdoc` warnings\r\n- [ ] You've updated the changelog (if adding/changing user-visible functionality)\r\n- [ ] You've updated the readme (if adding/changing user-visible functionality)\r\n- [ ] You've updated the refcard (if you made changes to the commands listed there)\r\n\r\nThanks!","created_at":"2016-06-14T15:17:38Z","updated_at":"2016-06-22T14:02:19Z","closed_at":null,"merged_at":null,"merge_commit_sha":"a7bab21a3bf1e2e4f16eddbdce9ee1903c836030","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785/commits","review_comments_url":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785/comments","review_comment_url":"https://api.github.com/repos/clojure-emacs/cider/pulls/comments{/number}","comments_url":"https://api.github.com/repos/clojure-emacs/cider/issues/1785/comments","statuses_url":"https://api.github.com/repos/clojure-emacs/cider/statuses/4a08a7e24704729c0176ae77181ccb6ae0924ae8","head":{"label":"cskksc:feature/multiline-eldoc","ref":"feature/multiline-eldoc","sha":"4a08a7e24704729c0176ae77181ccb6ae0924ae8","user":{"login":"cskksc","id":5201497,"avatar_url":"https://avatars.githubusercontent.com/u/5201497?v=3","gravatar_id":"","url":"https://api.github.com/users/cskksc","html_url":"https://github.com/cskksc","followers_url":"https://api.github.com/users/cskksc/followers","following_url":"https://api.github.com/users/cskksc/following{/other_user}","gists_url":"https://api.github.com/users/cskksc/gists{/gist_id}","starred_url":"https://api.github.com/users/cskksc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cskksc/subscriptions","organizations_url":"https://api.github.com/users/cskksc/orgs","repos_url":"https://api.github.com/users/cskksc/repos","events_url":"https://api.github.com/users/cskksc/events{/privacy}","received_events_url":"https://api.github.com/users/cskksc/received_events","type":"User","site_admin":false},"repo":{"id":54762226,"name":"cider","full_name":"cskksc/cider","owner":{"login":"cskksc","id":5201497,"avatar_url":"https://avatars.githubusercontent.com/u/5201497?v=3","gravatar_id":"","url":"https://api.github.com/users/cskksc","html_url":"https://github.com/cskksc","followers_url":"https://api.github.com/users/cskksc/followers","following_url":"https://api.github.com/users/cskksc/following{/other_user}","gists_url":"https://api.github.com/users/cskksc/gists{/gist_id}","starred_url":"https://api.github.com/users/cskksc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cskksc/subscriptions","organizations_url":"https://api.github.com/users/cskksc/orgs","repos_url":"https://api.github.com/users/cskksc/repos","events_url":"https://api.github.com/users/cskksc/events{/privacy}","received_events_url":"https://api.github.com/users/cskksc/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/cskksc/cider","description":"The Clojure Interactive Development Environment that Rocks for Emacs","fork":true,"url":"https://api.github.com/repos/cskksc/cider","forks_url":"https://api.github.com/repos/cskksc/cider/forks","keys_url":"https://api.github.com/repos/cskksc/cider/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cskksc/cider/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cskksc/cider/teams","hooks_url":"https://api.github.com/repos/cskksc/cider/hooks","issue_events_url":"https://api.github.com/repos/cskksc/cider/issues/events{/number}","events_url":"https://api.github.com/repos/cskksc/cider/events","assignees_url":"https://api.github.com/repos/cskksc/cider/assignees{/user}","branches_url":"https://api.github.com/repos/cskksc/cider/branches{/branch}","tags_url":"https://api.github.com/repos/cskksc/cider/tags","blobs_url":"https://api.github.com/repos/cskksc/cider/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cskksc/cider/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cskksc/cider/git/refs{/sha}","trees_url":"https://api.github.com/repos/cskksc/cider/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cskksc/cider/statuses/{sha}","languages_url":"https://api.github.com/repos/cskksc/cider/languages","stargazers_url":"https://api.github.com/repos/cskksc/cider/stargazers","contributors_url":"https://api.github.com/repos/cskksc/cider/contributors","subscribers_url":"https://api.github.com/repos/cskksc/cider/subscribers","subscription_url":"https://api.github.com/repos/cskksc/cider/subscription","commits_url":"https://api.github.com/repos/cskksc/cider/commits{/sha}","git_commits_url":"https://api.github.com/repos/cskksc/cider/git/commits{/sha}","comments_url":"https://api.github.com/repos/cskksc/cider/comments{/number}","issue_comment_url":"https://api.github.com/repos/cskksc/cider/issues/comments{/number}","contents_url":"https://api.github.com/repos/cskksc/cider/contents/{+path}","compare_url":"https://api.github.com/repos/cskksc/cider/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cskksc/cider/merges","archive_url":"https://api.github.com/repos/cskksc/cider/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cskksc/cider/downloads","issues_url":"https://api.github.com/repos/cskksc/cider/issues{/number}","pulls_url":"https://api.github.com/repos/cskksc/cider/pulls{/number}","milestones_url":"https://api.github.com/repos/cskksc/cider/milestones{/number}","notifications_url":"https://api.github.com/repos/cskksc/cider/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cskksc/cider/labels{/name}","releases_url":"https://api.github.com/repos/cskksc/cider/releases{/id}","deployments_url":"https://api.github.com/repos/cskksc/cider/deployments","created_at":"2016-03-26T04:17:18Z","updated_at":"2016-03-26T04:17:19Z","pushed_at":"2016-06-22T10:36:10Z","git_url":"git://github.com/cskksc/cider.git","ssh_url":"git@github.com:cskksc/cider.git","clone_url":"https://github.com/cskksc/cider.git","svn_url":"https://github.com/cskksc/cider","homepage":"","size":9825,"stargazers_count":0,"watchers_count":0,"language":"Emacs Lisp","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"clojure-emacs:master","ref":"master","sha":"0f8df598e7bc4a4e64aeceda8dc8111585a7ab75","user":{"login":"clojure-emacs","id":5080083,"avatar_url":"https://avatars.githubusercontent.com/u/5080083?v=3","gravatar_id":"","url":"https://api.github.com/users/clojure-emacs","html_url":"https://github.com/clojure-emacs","followers_url":"https://api.github.com/users/clojure-emacs/followers","following_url":"https://api.github.com/users/clojure-emacs/following{/other_user}","gists_url":"https://api.github.com/users/clojure-emacs/gists{/gist_id}","starred_url":"https://api.github.com/users/clojure-emacs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/clojure-emacs/subscriptions","organizations_url":"https://api.github.com/users/clojure-emacs/orgs","repos_url":"https://api.github.com/users/clojure-emacs/repos","events_url":"https://api.github.com/users/clojure-emacs/events{/privacy}","received_events_url":"https://api.github.com/users/clojure-emacs/received_events","type":"Organization","site_admin":false},"repo":{"id":4118920,"name":"cider","full_name":"clojure-emacs/cider","owner":{"login":"clojure-emacs","id":5080083,"avatar_url":"https://avatars.githubusercontent.com/u/5080083?v=3","gravatar_id":"","url":"https://api.github.com/users/clojure-emacs","html_url":"https://github.com/clojure-emacs","followers_url":"https://api.github.com/users/clojure-emacs/followers","following_url":"https://api.github.com/users/clojure-emacs/following{/other_user}","gists_url":"https://api.github.com/users/clojure-emacs/gists{/gist_id}","starred_url":"https://api.github.com/users/clojure-emacs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/clojure-emacs/subscriptions","organizations_url":"https://api.github.com/users/clojure-emacs/orgs","repos_url":"https://api.github.com/users/clojure-emacs/repos","events_url":"https://api.github.com/users/clojure-emacs/events{/privacy}","received_events_url":"https://api.github.com/users/clojure-emacs/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/clojure-emacs/cider","description":"The Clojure Interactive Development Environment that Rocks for Emacs","fork":false,"url":"https://api.github.com/repos/clojure-emacs/cider","forks_url":"https://api.github.com/repos/clojure-emacs/cider/forks","keys_url":"https://api.github.com/repos/clojure-emacs/cider/keys{/key_id}","collaborators_url":"https://api.github.com/repos/clojure-emacs/cider/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/clojure-emacs/cider/teams","hooks_url":"https://api.github.com/repos/clojure-emacs/cider/hooks","issue_events_url":"https://api.github.com/repos/clojure-emacs/cider/issues/events{/number}","events_url":"https://api.github.com/repos/clojure-emacs/cider/events","assignees_url":"https://api.github.com/repos/clojure-emacs/cider/assignees{/user}","branches_url":"https://api.github.com/repos/clojure-emacs/cider/branches{/branch}","tags_url":"https://api.github.com/repos/clojure-emacs/cider/tags","blobs_url":"https://api.github.com/repos/clojure-emacs/cider/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/clojure-emacs/cider/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/clojure-emacs/cider/git/refs{/sha}","trees_url":"https://api.github.com/repos/clojure-emacs/cider/git/trees{/sha}","statuses_url":"https://api.github.com/repos/clojure-emacs/cider/statuses/{sha}","languages_url":"https://api.github.com/repos/clojure-emacs/cider/languages","stargazers_url":"https://api.github.com/repos/clojure-emacs/cider/stargazers","contributors_url":"https://api.github.com/repos/clojure-emacs/cider/contributors","subscribers_url":"https://api.github.com/repos/clojure-emacs/cider/subscribers","subscription_url":"https://api.github.com/repos/clojure-emacs/cider/subscription","commits_url":"https://api.github.com/repos/clojure-emacs/cider/commits{/sha}","git_commits_url":"https://api.github.com/repos/clojure-emacs/cider/git/commits{/sha}","comments_url":"https://api.github.com/repos/clojure-emacs/cider/comments{/number}","issue_comment_url":"https://api.github.com/repos/clojure-emacs/cider/issues/comments{/number}","contents_url":"https://api.github.com/repos/clojure-emacs/cider/contents/{+path}","compare_url":"https://api.github.com/repos/clojure-emacs/cider/compare/{base}...{head}","merges_url":"https://api.github.com/repos/clojure-emacs/cider/merges","archive_url":"https://api.github.com/repos/clojure-emacs/cider/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/clojure-emacs/cider/downloads","issues_url":"https://api.github.com/repos/clojure-emacs/cider/issues{/number}","pulls_url":"https://api.github.com/repos/clojure-emacs/cider/pulls{/number}","milestones_url":"https://api.github.com/repos/clojure-emacs/cider/milestones{/number}","notifications_url":"https://api.github.com/repos/clojure-emacs/cider/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/clojure-emacs/cider/labels{/name}","releases_url":"https://api.github.com/repos/clojure-emacs/cider/releases{/id}","deployments_url":"https://api.github.com/repos/clojure-emacs/cider/deployments","created_at":"2012-04-23T22:53:44Z","updated_at":"2016-06-22T07:48:53Z","pushed_at":"2016-06-22T10:36:11Z","git_url":"git://github.com/clojure-emacs/cider.git","ssh_url":"git@github.com:clojure-emacs/cider.git","clone_url":"https://github.com/clojure-emacs/cider.git","svn_url":"https://github.com/clojure-emacs/cider","homepage":"https://cider.readthedocs.org","size":10758,"stargazers_count":1814,"watchers_count":1814,"language":"Emacs Lisp","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":328,"mirror_url":null,"open_issues_count":98,"forks":328,"open_issues":98,"watchers":1814,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785"},"html":{"href":"https://github.com/clojure-emacs/cider/pull/1785"},"issue":{"href":"https://api.github.com/repos/clojure-emacs/cider/issues/1785"},"comments":{"href":"https://api.github.com/repos/clojure-emacs/cider/issues/1785/comments"},"review_comments":{"href":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785/comments"},"review_comment":{"href":"https://api.github.com/repos/clojure-emacs/cider/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/clojure-emacs/cider/pulls/1785/commits"},"statuses":{"href":"https://api.github.com/repos/clojure-emacs/cider/statuses/4a08a7e24704729c0176ae77181ccb6ae0924ae8"}}}}
{"actor":{"display_login":"bbatsov"}}