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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

docs: unwrap complex array params #1753

Merged
merged 5 commits into from
Jan 21, 2023
Merged

docs: unwrap complex array params #1753

merged 5 commits into from
Jan 21, 2023

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Jan 18, 2023 •
edited
Loading

Currently the helpers.weightedArrayElement method does not "properly" display their parameters in our documentation.
This PR displays parameter description for complex array parameters (Array<{...}>)

Preview Diff

Old

grafik

New

grafik

New in combination with #1752

grafik

Found in #1752 .

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision labels Jan 18, 2023
@ST-DDT ST-DDT requested review from a team January 18, 2023 10:54
@ST-DDT ST-DDT self-assigned this Jan 18, 2023
@ST-DDT ST-DDT mentioned this pull request Jan 18, 2023
Merged
@codecov
Copy link

codecov bot commented Jan 18, 2023 •
edited
Loading

Codecov Report

Merging #1753 (51b274a) into next (440325e) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             next    #1753   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files        2340     2340           
  Lines      242612   242623   +11     
  Branches     1103     1103           
=======================================
+ Hits       241760   241771   +11     
  Misses        831      831           
  Partials       21       21
Impacted Files Coverage Δ
src/modules/helpers/index.ts 98.99% <100.00%> (+0.01%) ⬆️

Shinigami92
Shinigami92 approved these changes Jan 18, 2023
View reviewed changes
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ST-DDT ST-DDT requested a review from a team January 18, 2023 22:45
@ST-DDT ST-DDT added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Jan 19, 2023
@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 19, 2023

Team decision

We want this, we just aren't sure about the array[].value notation yet, but that isn't a blocker.

@ST-DDT ST-DDT enabled auto-merge (squash) January 21, 2023 18:55
@ST-DDT ST-DDT merged commit f839ae2 into next Jan 21, 2023
@ST-DDT ST-DDT deleted the docs/unwrap-complex-array-params branch January 21, 2023 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Shinigami92 Shinigami92 Shinigami92 approved these changes

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

Assignees

@ST-DDT ST-DDT

Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.x
Development

Successfully merging this pull request may close these issues.
3 participants
@ST-DDT @Shinigami92 @xDivisionByZerox