Skip to content

Commit b595c8f

Browse files
committed
chore(release): 4.0.0-rc.0
1 parent e5ea56d commit b595c8f

File tree

2 files changed

+56
-1
lines changed

2 files changed

+56
-1
lines changed

CHANGELOG.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,61 @@
22

33
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.
44

5+
<a name="4.0.0-rc.0"></a>
6+
# [4.0.0-rc.0](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.19...v4.0.0-rc.0) (2017-04-21)
7+
8+
9+
### Bug Fixes
10+
11+
* **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)
12+
* **params:** added code path for type RestElement ([6961ee8](https://github.com/documentationjs/documentation/commit/6961ee8))
13+
14+
15+
### Code Refactoring
16+
17+
* **nest:** Better nesting implementation ([#732](https://github.com/documentationjs/documentation/issues/732)) ([7374730](https://github.com/documentationjs/documentation/commit/7374730))
18+
19+
20+
### BREAKING CHANGES
21+
22+
* **nest:** referencing inferred destructure params without
23+
renaming them, like $0.x, from JSDoc comments will no longer
24+
work. To reference them, instead add a param tag to name the
25+
destructuring param, and then refer to members of that name.
26+
27+
Before:
28+
29+
```js
30+
/**
31+
* @param {number} $0.x a member of x
32+
*/
33+
function a({ x }) {}
34+
```
35+
36+
After:
37+
38+
```js
39+
/**
40+
* @param {Object} options
41+
* @param {number} options.x a member of x
42+
*/
43+
function a({ x }) {}
44+
```
45+
46+
* Address review comments
47+
48+
* Reduce testing node requirement back down to 4
49+
50+
* Don't output empty properties, reduce diff noise
51+
52+
* Rearrange and document params
53+
54+
* 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
55+
56+
* Use temporary fork to get through blocker
57+
58+
59+
560
<a name="4.0.0-beta.19"></a>
661
# [4.0.0-beta.19](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.18...v4.0.0-beta.19) (2017-04-10)
762

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "documentation",
33
"description": "a documentation generator",
4-
"version": "4.0.0-beta.19",
4+
"version": "4.0.0-rc.0",
55
"author": "Tom MacWright",
66
"bin": {
77
"documentation": "./bin/documentation.js"

0 commit comments

Comments
 (0)