docs: documents can be converted to data #2734

cipchk · 2019-01-03T04:34:00Z

规则

使用【｜】中文竖线符，表示 Union Types
- 例如：【有四种选择 success、info、warning、error】应在【类型列】表示【'success'｜'info'｜'warning'｜'error'】
【参数列】
- 保持纯粹性
  - 例如：【[nzValidateStatus](Reactive Forms)】应在【说明列】统一描述
【类型列】
- 应包含【``】代码包裹（保护 TemplateRef<void> 的有效性）
【默认值列】
- 保持纯粹性
  - 例如：【info，banner 模式下默认值为 warning】应把额外描述放置【说明列】
- 无默认值时应使用【-】替代，“无”应替代成【-】
站点样式：强制移除【类型列】所有 code 样式

完整示例

参数	说明	类型	默认值
`[nzBanner]`	是否用作顶部公告	`boolean`	`false`
`[nzCloseText]`	自定义关闭按钮	`string｜TemplateRef<void>`	-
`[nzShowIcon]`	是否显示辅助图标，`nzBanner` 模式下默认值为 `true`	`boolean`	`false`
`[nzType]`	指定警告提示的样式，`nzBanner` 模式下默认值为 `warning`	`'success'丨'info'丨'warning'丨'error'`	`'info'`
`[nzValidateStatus]`	（Reactive Forms）会根据 FormControl 的状态自动生成校验状态	`FormControl丨FormControlName`	`nz-form-control` 中包裹的第一个 `FormControl`
`[nzValidateStatus]`	（Template-driven Forms）校验状态	`'success'丨'warning'丨'error'丨'validating'`	-

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Application (the showcase website) / infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

merge

upgrade

- 使用【｜】中文竖线符，表示 Union Types - 例如：【有四种选择 `success`、`info`、`warning`、`error`】**应**在【类型列】表示【`success｜info｜warning｜error`】 - 【参数列】 - 保持纯粹性 - 例如：【`[nzValidateStatus]`(Reactive Forms)】**应**在【说明列】统一描述 - 【类型列】 - **应**包含【``】代码包裹（保护 `TemplateRef<void>` 的有效性） - 【默认值列】 - 保持纯粹性 - 例如：【`info`，`banner` 模式下默认值为 `warning`】**应**把额外描述放置【说明列】 - 无默认值时**应**使用【-】替代，“无”应替代成【-】 - 站点样式：强制移除【类型列】所有 `code` 样式 ## 完整示例 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` | | `[nzCloseText]` | 自定义关闭按钮 | `string｜TemplateRef<void>` | - | | `[nzShowIcon]` | 是否显示辅助图标，`nzBanner` 模式下默认值为 `true` | `boolean` | `false` | | `[nzType]` | 指定警告提示的样式，`nzBanner` 模式下默认值为 `warning` | `success丨info丨warning丨error` | `info` | | `[nzValidateStatus]` | （Reactive Forms）会根据 FormControl 的状态自动生成校验状态 | `FormControl丨FormControlName` | `nz-form-control` 中包裹的第一个 `FormControl` | | `[nzValidateStatus]` | （Template-driven Forms）校验状态 | `success丨warning丨error丨validating` | - |

netlify · 2019-01-03T04:42:14Z

Deploy preview for ng-zorro-master ready!

Built with commit a38c346

https://deploy-preview-2734--ng-zorro-master.netlify.com

codecov · 2019-01-03T04:44:53Z

Codecov Report

Merging #2734 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2734   +/-   ##
=======================================
  Coverage   95.57%   95.57%           
=======================================
  Files         515      515           
  Lines       12191    12191           
  Branches     1711     1711           
=======================================
  Hits        11652    11652           
  Misses        173      173           
  Partials      366      366

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8906dff...a38c346. Read the comment docs.

vthinkxie · 2019-01-03T08:21:39Z

强制移除【类型列】所有 code 样式，这句话怎么理解？

cipchk · 2019-01-03T08:25:17Z

@vthinkxie

cipchk · 2019-01-03T08:27:10Z

对于字串符型Union Types的表示是否有必要增加单引号标识：

success丨warning丨error丨validating

或

'success'丨'warning'丨'error'丨'validating'

vthinkxie · 2019-01-03T08:31:11Z

移除后应该是 string ｜ TemplateRef<void> 还是 string｜TemplateRef<void>?

cipchk · 2019-01-03T08:37:18Z

移除后应该是 string ｜ TemplateRef<void> 还是 string｜TemplateRef<void>?

我觉得二者都适应；但尽可能使用后者因为对于 Union Types 来说算是一体的。

hsuanxyz · 2019-01-03T08:47:07Z

对于字串符型Union Types的表示是否有必要增加单引号标识：
success丨warning丨error丨validating
或
'success'丨'warning'丨'error'丨'validating'

我认为应该加单引号

hsuanxyz · 2019-01-03T08:50:52Z

英文描述的首字母是否需要大写？现在的文档没有统一

vthinkxie · 2019-01-03T09:06:50Z

Description 部分的英文首字母这次先不调整好了，不影响解析
采用 string｜TemplateRef<void> 方式
Union Types 采用

'success'丨'warning'丨'error'丨'validating'

其他的都没有问题 @cipchk

wzhudev · 2019-01-07T11:29:51Z

有些方法存在返回, 如果没有返回应当如何处理, - 还是 void, 还是将返回字段留空? @cipchk

cipchk · 2019-01-07T11:38:55Z

有些方法存在返回, 如果没有返回应当如何处理, - 还是 void, 还是将返回字段留空? @cipchk

建议使用 void 更好一点；- 仅在组件属性中体现。

vthinkxie · 2019-01-09T09:36:33Z

Hi, @cipchk plz rebase master

cipchk · 2019-01-09T10:15:50Z

Hi, @cipchk plz rebase master

done

vthinkxie

LGTM

vthinkxie · 2019-01-10T11:08:35Z

@cipchk it would be better to add ci and contributor's doc to verify every commit to avoid break this.

* docs: documents can be converted to data - 使用【｜】中文竖线符，表示 Union Types - 例如：【有四种选择 `success`、`info`、`warning`、`error`】**应**在【类型列】表示【`success｜info｜warning｜error`】 - 【参数列】 - 保持纯粹性 - 例如：【`[nzValidateStatus]`(Reactive Forms)】**应**在【说明列】统一描述 - 【类型列】 - **应**包含【``】代码包裹（保护 `TemplateRef<void>` 的有效性） - 【默认值列】 - 保持纯粹性 - 例如：【`info`，`banner` 模式下默认值为 `warning`】**应**把额外描述放置【说明列】 - 无默认值时**应**使用【-】替代，“无”应替代成【-】 - 站点样式：强制移除【类型列】所有 `code` 样式 ## 完整示例 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` | | `[nzCloseText]` | 自定义关闭按钮 | `string｜TemplateRef<void>` | - | | `[nzShowIcon]` | 是否显示辅助图标，`nzBanner` 模式下默认值为 `true` | `boolean` | `false` | | `[nzType]` | 指定警告提示的样式，`nzBanner` 模式下默认值为 `warning` | `success丨info丨warning丨error` | `info` | | `[nzValidateStatus]` | （Reactive Forms）会根据 FormControl 的状态自动生成校验状态 | `FormControl丨FormControlName` | `nz-form-control` 中包裹的第一个 `FormControl` | | `[nzValidateStatus]` | （Template-driven Forms）校验状态 | `success丨warning丨error丨validating` | - | * chore: remove code style in Type column * docs: fix missing & losing component name * docs: update all * chore: remove type and default column code style * chore: 移除中文竖线，全部使用英文全角坚线 * chore: 修正不同组件之间相互引用相同属性 * chore: fix losing nz-popover in english * docs: remove 'or'

cipchk added 4 commits December 8, 2018 16:41

Merge pull request #1 from NG-ZORRO/master

f4e27e3

merge

Merge pull request #2 from NG-ZORRO/master

84b3c18

upgrade

Merge pull request #3 from NG-ZORRO/master

993ebea

upgrade

cipchk changed the title ~~docs: documents can be converted to data~~ WIP: docs: documents can be converted to data Jan 3, 2019

cipchk added 2 commits January 3, 2019 12:45

chore: remove code style in Type column

93dd9ad

docs: fix missing & losing component name

6e5cbb4

cipchk added 4 commits January 3, 2019 23:15

docs: update all

c997045

chore: remove type and default column code style

90ed8fe

chore: 移除中文竖线，全部使用英文全角坚线

0b64241

chore: 修正不同组件之间相互引用相同属性

7662e18

cipchk changed the title ~~WIP: docs: documents can be converted to data~~ docs: documents can be converted to data Jan 4, 2019

cipchk requested review from vthinkxie, simplejason, wilsoncook, hsuanxyz and wzhudev January 4, 2019 04:06

chore: fix losing nz-popover in english

c9055bb

hsuanxyz mentioned this pull request Jan 7, 2019

feat(module:empty): add empty component #2722

Merged

3 tasks

docs: remove 'or'

d98877f

Merge branch 'master' into dev-docs

a38c346

vthinkxie approved these changes Jan 10, 2019

View reviewed changes

vthinkxie merged commit e74acfc into NG-ZORRO:master Jan 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: documents can be converted to data #2734

docs: documents can be converted to data #2734

cipchk commented Jan 3, 2019 •

edited

Loading

netlify bot commented Jan 3, 2019 •

edited

Loading

codecov bot commented Jan 3, 2019 •

edited

Loading

vthinkxie commented Jan 3, 2019

cipchk commented Jan 3, 2019

cipchk commented Jan 3, 2019

vthinkxie commented Jan 3, 2019 •

edited

Loading

cipchk commented Jan 3, 2019

hsuanxyz commented Jan 3, 2019

hsuanxyz commented Jan 3, 2019

vthinkxie commented Jan 3, 2019 •

edited

Loading

wzhudev commented Jan 7, 2019

cipchk commented Jan 7, 2019

vthinkxie commented Jan 9, 2019

cipchk commented Jan 9, 2019

vthinkxie left a comment

vthinkxie commented Jan 10, 2019

docs: documents can be converted to data #2734

docs: documents can be converted to data #2734

Conversation

cipchk commented Jan 3, 2019 • edited Loading

规则

完整示例

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

netlify bot commented Jan 3, 2019 • edited Loading

codecov bot commented Jan 3, 2019 • edited Loading

Codecov Report

vthinkxie commented Jan 3, 2019

cipchk commented Jan 3, 2019

cipchk commented Jan 3, 2019

vthinkxie commented Jan 3, 2019 • edited Loading

cipchk commented Jan 3, 2019

hsuanxyz commented Jan 3, 2019

hsuanxyz commented Jan 3, 2019

vthinkxie commented Jan 3, 2019 • edited Loading

wzhudev commented Jan 7, 2019

cipchk commented Jan 7, 2019

vthinkxie commented Jan 9, 2019

cipchk commented Jan 9, 2019

vthinkxie left a comment

Choose a reason for hiding this comment

vthinkxie commented Jan 10, 2019

cipchk commented Jan 3, 2019 •

edited

Loading

netlify bot commented Jan 3, 2019 •

edited

Loading

codecov bot commented Jan 3, 2019 •

edited

Loading

vthinkxie commented Jan 3, 2019 •

edited

Loading

vthinkxie commented Jan 3, 2019 •

edited

Loading