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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate Planet names #2867

Open
matthewmayer opened this issue Apr 30, 2024 · 9 comments
Open

Generate Planet names #2867

matthewmayer opened this issue Apr 30, 2024 · 9 comments
Assignees
Labels
c: feature Request for new feature m: location Something is referring to the location module m: science Something is referring to the science module p: 1-normal Nothing urgent s: waiting for user interest Waiting for more users interested in this feature
Milestone

Comments

@matthewmayer
Copy link
Contributor

matthewmayer commented Apr 30, 2024

Clear and concise description of the problem

As a developer using faker i want to generate planet names.

  • My original usecase was as a placeholder location when I want to make it obvious that a location is fake (e.g. set location of a planned event on a events website to "Neptune")
  • Is a common set of placeholder names e.g. when thematically naming classes in a school https://www.kingsweston.bristol.sch.uk/Venus-Class/
  • Has other scientific use-cases

Suggested solution

Implement faker.science.planet() with the following data in English

[
    "Mercury",
    "Venus",
    "Earth",
    "Mars",
    "Jupiter",
    "Saturn",
    "Uranus",
    "Neptune"
]

Alternative

faker.location.planet()?

Additional context

No response

@matthewmayer matthewmayer added c: feature Request for new feature s: pending triage Pending Triage s: waiting for user interest Waiting for more users interested in this feature labels Apr 30, 2024
Copy link

Thank you for your feature proposal.

We marked it as "waiting for user interest" for now to gather some feedback from our community:

  • If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
  • If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.

We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.

We will start the implementation based on:

  • the number of votes (:+1:) and comments
  • the relevance for the ecosystem
  • availability of alternatives and workarounds
  • and the complexity of the requested feature

We do this because:

  • There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
  • Every feature we add to faker has "costs" associated to it:
    • initial costs: design, implementation, reviews, documentation
    • running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors

View more issues which are waiting for user interest

@matthewmayer matthewmayer self-assigned this Apr 30, 2024
@ST-DDT
Copy link
Member

ST-DDT commented Apr 30, 2024

Do you want exactly those well known planet names or any planet names?

@Shinigami92
Copy link
Member

Do you want exactly those well known planet names or any planet names?

This was exactly my first thought. Even if we dont want scientific planets now, we might want to consider a method name that does not get in conflict if we want to generate names like KMT-2021-BLG-1150L b

@matthewmayer
Copy link
Contributor Author

Just the major planets

@matthewmayer
Copy link
Contributor Author

Pluto is not a planet 😀

@xDivisionByZerox xDivisionByZerox removed the s: pending triage Pending Triage label Apr 30, 2024
@matthewmayer
Copy link
Contributor Author

For comparison Faker-Ruby has a few space methods. Their "planet" method is "planet (in our solar System)"
https://github.com/faker-ruby/faker/blob/main/doc/default/space.md

@matthewmayer matthewmayer added the m: science Something is referring to the science module label Apr 30, 2024
@ST-DDT
Copy link
Member

ST-DDT commented Apr 30, 2024

Currently, I think space is the best match, followed by location and then science.
From science.planet I would except the numbered planet notation.

@xDivisionByZerox
Copy link
Member

Currently, I think space is the best match, followed by location and then science.
From science.planet I would except the numbered planet notation.

I understand your reasoning, but I'm not a big fan of introducing new modules at the current moment. We still have some places where we are not sure whether a function would be better located in module X or Y. Adding more modules makes this problem potentially worse until we have clear definitions about the "Module" term, or we introduce an easy way to reference aliases.

That being said, I would not expect planet to be located under the LocationModule as this has more of an "on earth locations"-vibe to me.
Science sounds reasonable to me. But again, @ST-DDT made a good point with the "numbered planet notations".


Another thing I want to point out is the method faker.person.zodiacSign. While not directly related, they could end out being on the same meta level. I just want this to be considered. Not putting "planet" into the PersonModule, but the fact of potential relation in general.

@ST-DDT
Copy link
Member

ST-DDT commented Apr 30, 2024

Nothing we have to decide now, lets wait on more input/upvotes.

@ST-DDT ST-DDT added this to the vFuture milestone Apr 30, 2024
@ST-DDT ST-DDT added p: 1-normal Nothing urgent m: location Something is referring to the location module labels Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: feature Request for new feature m: location Something is referring to the location module m: science Something is referring to the science module p: 1-normal Nothing urgent s: waiting for user interest Waiting for more users interested in this feature
Projects
None yet
Development

No branches or pull requests

4 participants