{"action":"created","issue":{"url":"https://api.github.com/repos/mochajs/mocha/issues/2282","repository_url":"https://api.github.com/repos/mochajs/mocha","labels_url":"https://api.github.com/repos/mochajs/mocha/issues/2282/labels{/name}","comments_url":"https://api.github.com/repos/mochajs/mocha/issues/2282/comments","events_url":"https://api.github.com/repos/mochajs/mocha/issues/2282/events","html_url":"https://github.com/mochajs/mocha/issues/2282","id":157295460,"number":2282,"title":"Improve README usefulness","user":{"login":"dasilvacontin","id":1260830,"avatar_url":"https://avatars.githubusercontent.com/u/1260830?v=3","gravatar_id":"","url":"https://api.github.com/users/dasilvacontin","html_url":"https://github.com/dasilvacontin","followers_url":"https://api.github.com/users/dasilvacontin/followers","following_url":"https://api.github.com/users/dasilvacontin/following{/other_user}","gists_url":"https://api.github.com/users/dasilvacontin/gists{/gist_id}","starred_url":"https://api.github.com/users/dasilvacontin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dasilvacontin/subscriptions","organizations_url":"https://api.github.com/users/dasilvacontin/orgs","repos_url":"https://api.github.com/users/dasilvacontin/repos","events_url":"https://api.github.com/users/dasilvacontin/events{/privacy}","received_events_url":"https://api.github.com/users/dasilvacontin/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2016-05-27T21:40:44Z","updated_at":"2016-06-09T03:35:17Z","closed_at":null,"body":"- [ ] why mocha vs other js test frameworks? differences\r\n- [ ] getting started with testing and mocha\r\n- [ ] simple example maybe?\r\n- [ ] how to contribute / how to get started contributing\r\n- [ ] etc (suggest; specially if you personally found something lacking)"},"comment":{"url":"https://api.github.com/repos/mochajs/mocha/issues/comments/224792362","html_url":"https://github.com/mochajs/mocha/issues/2282#issuecomment-224792362","issue_url":"https://api.github.com/repos/mochajs/mocha/issues/2282","id":224792362,"user":{"login":"ScottFreeCode","id":16506071,"avatar_url":"https://avatars.githubusercontent.com/u/16506071?v=3","gravatar_id":"","url":"https://api.github.com/users/ScottFreeCode","html_url":"https://github.com/ScottFreeCode","followers_url":"https://api.github.com/users/ScottFreeCode/followers","following_url":"https://api.github.com/users/ScottFreeCode/following{/other_user}","gists_url":"https://api.github.com/users/ScottFreeCode/gists{/gist_id}","starred_url":"https://api.github.com/users/ScottFreeCode/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ScottFreeCode/subscriptions","organizations_url":"https://api.github.com/users/ScottFreeCode/orgs","repos_url":"https://api.github.com/users/ScottFreeCode/repos","events_url":"https://api.github.com/users/ScottFreeCode/events{/privacy}","received_events_url":"https://api.github.com/users/ScottFreeCode/received_events","type":"User","site_admin":false},"created_at":"2016-06-09T03:35:17Z","updated_at":"2016-06-09T03:35:17Z","body":"- We've already got good documentation of [async hooks](http://mochajs.org/#asynchronous-hooks) and [the delay option,](http://mochajs.org/#delayed-root-suite) yet we continue to get [requests for a before-describe hook](https://github.com/mochajs/mocha/issues/1628#issuecomment-222486717)... Is there a way to increase the discoverability of the existing documentation?\r\n- Then again, those examples show a certain disparity -- the async hooks one assumes you're familiar with or able to figure out the particular database API used, the delay one uses a contrivedly simple demonstration with `setTimeout`; ideally, both would be somewhere in between, trivial to understand but not just contrived.\r\n- Double-check that documentation is not misleading re. local vs. global installation, per https://github.com/mochajs/mocha/issues/291#issuecomment-224417120\r\n- We get occasional [questions about use with ES6](https://github.com/mochajs/mocha/issues/1916#issuecomment-224481628); the docs currently mention that `--compilers` can be used for Coffeescript and don't elaborate on anything else in that regard.\r\n- We get occasional [confusion about `only` really being an alternative way to `grep`](2226). I can make a case that `only` should be changed in a future backwards-incompatible version, but until then, let's document this behavior under both `grep` (both [commandline](http://mochajs.org/#g---grep-pattern) and [in-browser](http://mochajs.org/#grep)) and [`only`](http://mochajs.org/#exclusive-tests).\r\n- `mocha.grep(...)` is undocumented.\r\n- \"Pending Tests\" and \"Inclusive Tests\" (that is, skipped tests; tangentially, \"inclusive\" doesn't make much sense to me as a name for it in and of itself -- it only kinda sorta makes sense by way of contrast with `only` being \"exclusive tests\"), which are very similar on a technical level (although serving distinct purposes -- one is \"let's write this later\" and another is \"this is written, but we need to avoid running it in some or all cases\"), are on either side of \"Exclusive Tests\" (`only`) instead of next to each other. We should consider whether that's a good thing or a bad thing.\r\n- If there's a programmatic API parameter for `watch`, make sure it's documented, per #2293.\r\n- #2296 is about documentation for setting timeout in hooks.\r\n\r\n...Those are all the other issues I could find relating to (or suggesting need of) documentation.\r\n\r\nWe should probably consolidate these into a single list in the OP (with editting out of any inapplicable ones if necessary)."}}
{"actor":{"display_login":"ScottFreeCode"}}