Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Form onFieldsChange(): document third parameter "allFields", remove non-existent fourth parameter "add" from TypeScript definition #16343

Merged

Conversation

@sbusch
Copy link
Contributor

@sbusch sbusch commented Apr 26, 2019

馃 This is a ...

  • Site / document update
  • TypeScript definition update

馃懟 What's the background?

Form onFieldsChange() has a third parameter allFields, see 619b0ed. That was not documented.

Additionally, TypeScript def added a fourth parameter add: string by mistake (that parameter does not exist)

馃挕 Solution

Add docs for allFields param, remove add param from TypeScript definition.

馃摑 Changelog

No special changelog required.

鈽戯笍 Self Check before Merge

  • Doc is not updated (purpose of this PR)
  • Demo is not needed
  • TypeScript definition is updated (also purpose of this PR)
  • Changelog is not needed
@sbusch sbusch changed the title Form on fields change typescript and docs Form onFieldsChange(): document third parameter "allFields", remove non-existent fourth parameter "add" from TypeScript definition Apr 26, 2019
@netlify
Copy link

@netlify netlify bot commented Apr 26, 2019

Deploy preview for ant-design ready!

Built with commit 0b875cf

https://deploy-preview-16343--ant-design.netlify.com

@codecov
Copy link

@codecov codecov bot commented Apr 26, 2019

Codecov Report

Merging #16343 into master will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #16343      +/-   ##
==========================================
+ Coverage   95.28%   95.32%   +0.04%     
==========================================
  Files         253      253              
  Lines        6780     6780              
  Branches     1968     1933      -35     
==========================================
+ Hits         6460     6463       +3     
+ Misses        319      316       -3     
  Partials        1        1
Impacted Files Coverage 螖
components/form/Form.tsx 88.88% <酶> (酶) 猬嗭笍
components/_util/wave.tsx 88.46% <0%> (+2.88%) 猬嗭笍

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 04001a0...0b875cf. Read the comment docs.

1 similar comment
@codecov
Copy link

@codecov codecov bot commented Apr 26, 2019

Codecov Report

Merging #16343 into master will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #16343      +/-   ##
==========================================
+ Coverage   95.28%   95.32%   +0.04%     
==========================================
  Files         253      253              
  Lines        6780     6780              
  Branches     1968     1933      -35     
==========================================
+ Hits         6460     6463       +3     
+ Misses        319      316       -3     
  Partials        1        1
Impacted Files Coverage 螖
components/form/Form.tsx 88.88% <酶> (酶) 猬嗭笍
components/_util/wave.tsx 88.46% <0%> (+2.88%) 猬嗭笍

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 04001a0...0b875cf. Read the comment docs.

@zombieJ zombieJ merged commit 5ce2f89 into ant-design:master Apr 28, 2019
30 of 31 checks passed
30 of 31 checks passed
@semantic-pull-requests[bot]
Semantic Pull Request add a semantic commit or PR title
Details
@netlify[bot]
Header rules No header rules processed
Details
@netlify[bot]
Pages changed 213 new files uploaded
Details
Codacy/PR Quality Review Up to standards. A positive pull request.
Details
CodeFactor No issues found.
Details
@dep[bot]
DEP All dependencies are resolved
LGTM analysis: JavaScript No new or fixed alerts
Details
@netlify[bot]
Mixed content No mixed content detected
Details
@netlify[bot]
Redirect rules 18 redirect rules processed
Details
@wip[bot]
WIP Ready for review
Details
ant-design.ant-design #ant design succeeded
Details
@buildsize[bot]
buildsize No change
Details
ci/circleci: compile Your tests passed on CircleCI!
Details
ci/circleci: dist Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test_dist Your tests passed on CircleCI!
Details
ci/circleci: test_dist_15 Your tests passed on CircleCI!
Details
ci/circleci: test_dom Your tests passed on CircleCI!
Details
ci/circleci: test_dom_15 Your tests passed on CircleCI!
Details
ci/circleci: test_es Your tests passed on CircleCI!
Details
ci/circleci: test_es_15 Your tests passed on CircleCI!
Details
ci/circleci: test_lib Your tests passed on CircleCI!
Details
ci/circleci: test_lib_15 Your tests passed on CircleCI!
Details
ci/circleci: test_node Your tests passed on CircleCI!
Details
ci/circleci: test_node_15 Your tests passed on CircleCI!
Details
codebeat 6 issues resolved and 6 introduced
Details
@codecov[bot]
codecov/patch Coverage not affected when comparing 04001a0...0b875cf
Details
@codecov[bot]
codecov/project 95.32% (+0.04%) compared to 04001a0
Details
@netlify[bot]
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (paranoidjk) No manifest changes detected
@sbusch sbusch deleted the form-onFieldsChange-typescript-and-docs branch May 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants