Update browsable-api.md#9509

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

auvipy merged 3 commits intoencode:masterfromrafaelgramoschi:patch-1

Aug 27, 2024

Merged

Update browsable-api.md#9509

auvipy merged 3 commits intoencode:masterfromrafaelgramoschi:patch-1

Aug 27, 2024

Conversation

Copy link

Contributor

rafaelgramoschi commentedAug 21, 2024•
edited
Loading

The documentation uses a deprecated method url(), use re_path() instead. Explicit imports (which were not specified).

Note: Before submitting a code change, please review ourcontributing guidelines.

Description

Documentation edited: deprecated method correction.

Update browsable-api.md

54884a5

Deprecated url(), use re_path(). Show imports.

ulgens reviewed

Aug 22, 2024

View reviewed changes

docs/topics/browsable-api.md Outdated

		urlpatterns = [
		# ...
		url(r"^api-auth/", include("rest_framework.urls", namespace="rest_framework"))
		re_path(r"^api-auth/", include("rest_framework.urls", namespace="rest_framework"))

Copy link

Contributor

ulgensAug 22, 2024•
edited
Loading

Choose a reason for hiding this comment

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

This doesn't need to be a regex,path("api-auth/")... is just fine.

Copy link

ContributorAuthor

rafaelgramoschiAug 27, 2024

Choose a reason for hiding this comment

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

Little note about why i suggested re_path and not path (searching stackoverflow):
re_path() is similar tourl() (both have regex support).
path() doesn't. (See Django docs)
But you are right, most of the docs usepath()