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

feat: add docs for GoTrue (Sourcery refactored) #181

Merged
merged 1 commit into from
Oct 30, 2022

Conversation

sourcery-ai[bot]
Copy link
Contributor

@sourcery-ai sourcery-ai bot commented Oct 30, 2022

Pull Request #180 refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the j0/add_docs branch, then run:

git fetch origin sourcery/j0/add_docs
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

@sourcery-ai sourcery-ai bot requested a review from J0 October 30, 2022 15:27
headers = {**self.headers}
headers["Authorization"] = f"Bearer {jwt}"
headers = {**self.headers, "Authorization": f"Bearer {jwt}"}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Function AsyncGoTrueAPI._create_request_headers refactored with the following changes:

@sourcery-ai
Copy link
Contributor Author

sourcery-ai bot commented Oct 30, 2022

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.13%.

Quality metrics Before After Change
Complexity 0.79 ⭐ 0.80 ⭐ 0.01 👎
Method Length 53.27 ⭐ 53.15 ⭐ -0.12 👍
Working memory 6.76 🙂 6.80 🙂 0.04 👎
Quality 80.72% 80.59% -0.13% 👎
Other metrics Before After Change
Lines 615 614 -1
Changed files Quality Before Quality After Quality Change
gotrue/_async/api.py 80.72% ⭐ 80.59% ⭐ -0.13% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@J0 J0 merged commit 7482f1a into j0/add_docs Oct 30, 2022
@leynier leynier deleted the sourcery/j0/add_docs branch November 16, 2022 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant