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

Improve deprecation message for faker.image.abstract() etc #2019

Closed
matthewmayer opened this issue Apr 4, 2023 · 1 comment · Fixed by #2040
Closed

Improve deprecation message for faker.image.abstract() etc #2019

matthewmayer opened this issue Apr 4, 2023 · 1 comment · Fixed by #2040
Assignees
@matthewmayer
Labels
c: chore PR that doesn't affect the runtime behavior c: docs Improvements or additions to documentation needs documentation Documentations are needed p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone
v8.x

Comments

@matthewmayer
Copy link
Contributor

matthewmayer commented Apr 4, 2023 •
edited
Loading

The deprecation message for faker.image.abstract() etc points to faker.image.url() which doesn't support a category.

image

Originally posted by @matthewmayer in #2014 (comment)

Maybe we should change that to point to faker.image.urlLoremFlickr({category:"abstract"}) instead then, since only this provider supports categories?

Alternatively faker.image.url() could be modified to accept a category parameter (in which case it would always use LoremFlickr instead of Picsum or LoremFlickr alternately)
@matthewmayer matthewmayer added c: docs Improvements or additions to documentation needs documentation Documentations are needed c: chore PR that doesn't affect the runtime behavior s: needs decision Needs team/maintainer decision labels Apr 4, 2023
@matthewmayer matthewmayer self-assigned this Apr 4, 2023
@matthewmayer matthewmayer added the p: 1-normal Nothing urgent label Apr 4, 2023
@matthewmayer matthewmayer moved this to Todo in Faker Roadmap Apr 4, 2023
@ST-DDT
Copy link
Member

ST-DDT commented Apr 6, 2023

Team Decision

We want this.

  • Add links to faker.image.urlLoremFlickr({category})
  • Add @see faker.image.url "If you just want an image"
  • Add @see faker.iamge.urlLoremFlickr "If you want an image from loremflickr giving your more options for requesting a matching one."

@ST-DDT ST-DDT added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Apr 6, 2023
@matthewmayer matthewmayer mentioned this issue Apr 12, 2023
Merged
@github-project-automation github-project-automation bot moved this from Todo to Done in Faker Roadmap Apr 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewmayer matthewmayer

Labels
c: chore PR that doesn't affect the runtime behavior c: docs Improvements or additions to documentation needs documentation Documentations are needed 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(image): explain deprecation of category methods matthewmayer/faker
2 participants
@matthewmayer @ST-DDT