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

Mark Mersenne module as internal and hide it from ts and the api-docs #1348

Closed
ST-DDT opened this issue Sep 6, 2022 · 2 comments · Fixed by #1444 or #1447
Closed

Mark Mersenne module as internal and hide it from ts and the api-docs #1348

ST-DDT opened this issue Sep 6, 2022 · 2 comments · Fixed by #1444 or #1447
Assignees
@Shinigami92
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 p: 1-normal Nothing urgent
Milestone
v8.0 - Module Re-...

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Sep 6, 2022 •
edited
Loading

Clear and concise description of the problem

The mersenne module is an internal module that should be called by external users/libraries.

Suggested solution

  • Mark the mersenne module as internal
  • Hide the field references/mark them as internal or private
  • Hide the Mersenne module from the api-docs

Alternative

  • Remove the mersenne module/merge it with the main Faker class

Additional context

No response
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation c: feature Request for new feature s: on hold Blocked by something or frozen to avoid conflicts p: 1-normal Nothing urgent 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 labels Sep 6, 2022
@ST-DDT ST-DDT added this to the v8.0 - Module Re-Shuffling milestone Sep 6, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Sep 6, 2022

Blocked by #932 / #1291

@ST-DDT ST-DDT added good first issue Good for newcomers s: on hold Blocked by something or frozen to avoid conflicts and removed s: on hold Blocked by something or frozen to avoid conflicts labels Oct 6, 2022
@ST-DDT ST-DDT mentioned this issue Oct 11, 2022
Merged
@ST-DDT ST-DDT removed the s: on hold Blocked by something or frozen to avoid conflicts label Oct 12, 2022
@Shinigami92 Shinigami92 self-assigned this Oct 13, 2022
@Shinigami92
Copy link
Member

Blocked by

@Shinigami92 Shinigami92 removed the c: feature Request for new feature label Oct 13, 2022
@Shinigami92 Shinigami92 mentioned this issue Oct 13, 2022
Merged
@Shinigami92 Shinigami92 linked a pull request Oct 13, 2022 that will close this issue
refactor!: make mersenne internal #1444
Merged
@Shinigami92 Shinigami92 removed the good first issue Good for newcomers label Oct 13, 2022
@Shinigami92 Shinigami92 linked a pull request Oct 15, 2022 that will close this issue
refactor(mersenne): rewrite internal mersenne #1447
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Shinigami92 Shinigami92

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 p: 1-normal Nothing urgent
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.0 - Module Re-Shuffling
2 participants
@ST-DDT @Shinigami92