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(docs): split generate:api-docs execution from import #1779

Merged
merged 10 commits into from
Jan 29, 2023

Conversation

ST-DDT
Copy link
Member

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

This PR splits the api docs generation implementation from the execution.
This allows other scripts to import the code or parts thereof without actually generating the code.
This refactoring allowed me to reduce some more code duplication.

@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 24, 2023
@ST-DDT ST-DDT requested review from a team January 24, 2023 23:01
@ST-DDT ST-DDT self-assigned this Jan 24, 2023
@codecov
Copy link

codecov bot commented Jan 24, 2023

Codecov Report

Merging #1779 (f893696) into next (0bc6c2f) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1779   +/-   ##
=======================================
  Coverage   99.65%   99.65%           
=======================================
  Files        2340     2340           
  Lines      242653   242653           
  Branches     1111     1111           
=======================================
  Hits       241804   241804           
  Misses        828      828           
  Partials       21       21           

@ST-DDT ST-DDT changed the title docs: split execution from call refactor(docs): split generate:api-docs execution from import Jan 24, 2023
@ST-DDT ST-DDT marked this pull request as ready for review January 24, 2023 23:18
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

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

This took me longer to understand than I'm proud of to admit. Thanks for the PR description.

@ST-DDT ST-DDT requested a review from a team January 26, 2023 22:59
@ST-DDT ST-DDT enabled auto-merge (squash) January 29, 2023 15:28
@ST-DDT ST-DDT merged commit ac1a3de into next Jan 29, 2023
@ST-DDT ST-DDT deleted the docs/generate-split-execution-from-call branch January 29, 2023 15:35
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
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants