Skip to content

Commit

Permalink
docs: Add get_signup_redirect_url docstring
Browse files Browse the repository at this point in the history
# Submitting Pull Requests

## General

 - [ ] Make sure you use [semantic commit messages](https://seesparkbox.com/foundry/semantic_commit_messages).
       Examples: `"fix(google): Fixed foobar bug"`, `"feat(accounts): Added foobar feature"`.
 - [ ] All Python code must formatted using Black, and clean from pep8 and isort issues.
 - [ ] JavaScript code should adhere to [StandardJS](https://standardjs.com).
 - [ ] If your changes are significant, please update `ChangeLog.rst`.
 - [ ] If your change is substantial, feel free to add yourself to `AUTHORS`.

 ## Provider Specifics

 In case you add a new provider:

- [ ] Make sure unit tests are available.
- [ ] Add an entry of your provider in `test_settings.py::INSTALLED_APPS` and `docs/installation.rst::INSTALLED_APPS`.
- [ ] Add documentation to `docs/providers/<provider name>.rst` and `docs/providers/index.rst` Provider Specifics toctree.
- [ ] Add an entry to the list of supported providers over at `docs/overview.rst`.

Just adding some comments to help with documentation generation.

Reviewed-on: https://codeberg.org/allauth/django-allauth/pulls/4202
Co-authored-by: devo-wm <[email protected]>
Co-committed-by: devo-wm <[email protected]>
  • Loading branch information
devo-wm authored and pennersr committed Dec 27, 2024
1 parent 4867048 commit 0e4791b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions allauth/account/adapter.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,9 @@ def send_mail(self, template_prefix: str, email: str, context: dict) -> None:
msg.send()

def get_signup_redirect_url(self, request):
"""
Returns the default URL to redirect to directly after signing up.
"""
return resolve_url(app_settings.SIGNUP_REDIRECT_URL)

def get_login_redirect_url(self, request):
Expand Down

0 comments on commit 0e4791b

Please sign in to comment.