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

Add authenticated decorator to handlers in doc #219

Merged
merged 2 commits into from
May 5, 2020

Conversation

fcollonval
Copy link
Member

I think it would be good to recommend using the authenticated decorator in the documentation examples for the extension handlers.

@Zsailer
Copy link
Member

Zsailer commented May 3, 2020

Ah, that's a great point—though, it adds some extra complexity to the example without explanation.

Do you mind adding a sentence somewhere (maybe a parenthetical) in these docs to help acknowledge why the decorator is there? Maybe a sentence like:
"(it's best practice to wrap each handler method with the "authenticated" decorator to ensure that each request is authenticated by the server)".

@fcollonval
Copy link
Member Author

Thanks for the review and the sentence 😜 @Zsailer

Copy link
Member

@Zsailer Zsailer left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks, @fcollonval

@Zsailer Zsailer merged commit ed1ca52 into jupyter-server:master May 5, 2020
@blink1073 blink1073 added this to the 1.0 Release milestone Sep 17, 2020
hMED22 pushed a commit to hMED22/jupyter_server that referenced this pull request Jan 23, 2023
Add `authenticated` decorator to handlers in doc
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.

3 participants