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

refactor: reorganize apidoc scripts and reuse them for tests #1759

Merged
merged 9 commits into from
Jan 23, 2023

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Jan 19, 2023

The api doc scripts have grown over time and now multiple classes contain functions that import/user other files.
This PR reorganizes the methods into different files to keep the methods together.

I also added some new helper methods that simplify certain code parts and improve reuse-ability.

@ST-DDT ST-DDT added p: 1-normal Nothing urgent c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs labels Jan 19, 2023
@ST-DDT ST-DDT requested review from a team January 19, 2023 18:27
@ST-DDT ST-DDT self-assigned this Jan 19, 2023
@ST-DDT ST-DDT changed the title refactor: reorganize apidoc scripts and reuse it for tests refactor: reorganize apidoc scripts and reuse them for tests Jan 19, 2023
@codecov
Copy link

codecov bot commented Jan 19, 2023

Codecov Report

Merging #1759 (d57bdd4) into next (826cb0b) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1759   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files        2340     2340           
  Lines      242624   242624           
  Branches     1103     1103           
=======================================
  Hits       241772   241772           
  Misses        831      831           
  Partials       21       21           

@ST-DDT ST-DDT marked this pull request as ready for review January 19, 2023 19:29
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM
But please lets wait for next meeting to discuss the pseudo deletion as I'm not quite sure right now if this is the right way to go

Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ST-DDT reverted the additional change, so if we decide next team meeting if that was the correct way, we can do it in a separate PR ❤️ 👍

@ST-DDT ST-DDT requested a review from a team January 20, 2023 20:03
@ST-DDT ST-DDT enabled auto-merge (squash) January 23, 2023 17:32
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Jan 23, 2023
@ST-DDT ST-DDT merged commit 23aa088 into next Jan 23, 2023
@ST-DDT ST-DDT deleted the refactor/scripts/apidoc branch January 23, 2023 17:47
matthewmayer pushed a commit to matthewmayer/faker that referenced this pull request Feb 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants