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

Add includeAlpha to color examples #1967

Closed
ST-DDT opened this issue Mar 23, 2023 · 2 comments · Fixed by #1970
Closed

Add includeAlpha to color examples #1967

ST-DDT opened this issue Mar 23, 2023 · 2 comments · Fixed by #1970
Assignees
@matthewmayer
Labels
c: docs Improvements or additions to documentation m: color Something is referring to the color module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone
v8.x

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Mar 23, 2023 

          can we add some `includeAlpha` examples too?

Originally posted by @matthewmayer in #1958 (comment)
@ST-DDT ST-DDT mentioned this issue Mar 23, 2023
Merged
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug m: color Something is referring to the color module labels Mar 23, 2023
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Mar 23, 2023
@matthewmayer matthewmayer self-assigned this Mar 23, 2023
@matthewmayer
Copy link
Contributor

i noticed that there are multiple documentation blocks above the different signatures, which have a different set of examples, for example this line

faker/src/modules/color/index.ts

Line 296 in 233a4de

* faker.color.rgb({ format: 'decimal', includeAlpha: true }) // [52, 250, 209, 0.21]
but that doesnt show in the online documentation.

If there are multiple signatures, how does the api docs decide which one to use? Should they all have the same set of examples?

@ST-DDT
Copy link
Member Author

ST-DDT commented Mar 23, 2023

It will show the last signature only.

@matthewmayer matthewmayer mentioned this issue Mar 24, 2023
Merged
@github-project-automation github-project-automation bot moved this from Todo to Done in Faker Roadmap Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewmayer matthewmayer

Labels
c: docs Improvements or additions to documentation m: color Something is referring to the color module 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 a pull request may close this issue.

docs(color): improve rgb examples matthewmayer/faker
2 participants
@matthewmayer @ST-DDT