From b595c8f33fc0aede9305339e8cd2225945a02c8f Mon Sep 17 00:00:00 2001 From: Tom Macwright Date: Fri, 21 Apr 2017 19:01:10 -0400 Subject: [PATCH] chore(release): 4.0.0-rc.0 --- CHANGELOG.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 56 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cb7968e..40527bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,61 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. + +# [4.0.0-rc.0](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.19...v4.0.0-rc.0) (2017-04-21) + + +### Bug Fixes + +* **html output:** Fix github links in HTML output ([#745](https://github.com/documentationjs/documentation/issues/745)) ([9554b2f](https://github.com/documentationjs/documentation/commit/9554b2f)), closes [#738](https://github.com/documentationjs/documentation/issues/738) +* **params:** added code path for type RestElement ([6961ee8](https://github.com/documentationjs/documentation/commit/6961ee8)) + + +### Code Refactoring + +* **nest:** Better nesting implementation ([#732](https://github.com/documentationjs/documentation/issues/732)) ([7374730](https://github.com/documentationjs/documentation/commit/7374730)) + + +### BREAKING CHANGES + +* **nest:** referencing inferred destructure params without +renaming them, like $0.x, from JSDoc comments will no longer +work. To reference them, instead add a param tag to name the +destructuring param, and then refer to members of that name. + +Before: + +```js +/** + * @param {number} $0.x a member of x + */ +function a({ x }) {} +``` + +After: + +```js +/** + * @param {Object} options + * @param {number} options.x a member of x + */ +function a({ x }) {} +``` + +* Address review comments + +* Reduce testing node requirement back down to 4 + +* Don't output empty properties, reduce diff noise + +* Rearrange and document params + +* Simplify param inference, update test fixtures. This is focused around Array destructuring: documenting destructured array elements with indices instead of names, because the names are purely internal details + +* Use temporary fork to get through blocker + + + # [4.0.0-beta.19](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.18...v4.0.0-beta.19) (2017-04-10) diff --git a/package.json b/package.json index 043ed91..67fa2e1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "documentation", "description": "a documentation generator", - "version": "4.0.0-beta.19", + "version": "4.0.0-rc.0", "author": "Tom MacWright", "bin": { "documentation": "./bin/documentation.js"