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.

Sign up for GitHub

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

Jump to bottom

Clean up doctests #26

Open
juulSme opened this issue Mar 2, 2023 · 0 comments
Open

Clean up doctests #26

juulSme opened this issue Mar 2, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@juulSme
Copy link
Collaborator

juulSme commented Mar 2, 2023

Currently, the doctests contain calls to internal code (that is not part of the lib API) and even, in some places, raw Redis commands. While this is perfectly fine when writing a (normal) test, it is not helpful documentation. Such code should be removed, most importantly in the main "entry modules", that is, SessionPlugs and TokenPlugs. TokenFactory.Jwt and RedisStore are of secondary importance.
@juulSme juulSme added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 2, 2023
@juulSme juulSme changed the title Clean-up doctests Clean up doctests Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@juulSme