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

Support sub modules or not #1475

Closed
ST-DDT opened this issue Oct 22, 2022 · 3 comments
Closed

Support sub modules or not #1475

ST-DDT opened this issue Oct 22, 2022 · 3 comments
Labels
breaking change Cannot be merged when next version is not a major release c: docs Improvements or additions to documentation c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs m: image Something is referring to the image module p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Oct 22, 2022

Clear and concise description of the problem

Currently, we have sub modules e.g. the image providers. But they arent supported by our docs generation.

Suggested solution

Decide whether we want sub modules or not.

If we want them, then they should be properly supported by the docs generation.
If not, we should deprecate them for removal.

Alternative

No response

Additional context

If we are going to support them, we have to rename them, so their name can be used to automatically generate them.

E.g. LoremImageModule -> faker.image.lorem

I would take care of the docs generation changes.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs breaking change Cannot be merged when next version is not a major release m: image Something is referring to the image module labels Oct 22, 2022
@ST-DDT ST-DDT added this to the v8.0 - Module Re-Shuffling milestone Oct 22, 2022
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Oct 22, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Oct 22, 2022

IMO it is OK to have them, maybe we should add a hint to them that these are external modules and thus may break somewhen in the future.

@Shinigami92
Copy link
Member

Shinigami92 commented Oct 22, 2022

I currently feel like I have much todo (in other projects), but as I want to champion the image module, I will try to first find a way of getting rid of the image providers as it is currently in v7.
If I didn't find a successful way the team accepts, then I'm going with the team and we might need to support these sub modules officially.

Linking:

@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 26, 2023

We decide this when we need this.

@ST-DDT ST-DDT closed this as completed Jan 26, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in Faker Roadmap Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Cannot be merged when next version is not a major release c: docs Improvements or additions to documentation c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs m: image Something is referring to the image module p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision
Projects
No open projects
Status: Done
Development

No branches or pull requests

2 participants