Add documentation to (at least) all public structs, enums, functions and traits #148
Labels
documentation
Improvements or additions to documentation
Comments
seblund
pushed a commit
that referenced
this issue
May 11, 2023
This was broken because it required Reveaal to store all the user tokens that is has given out. This violates the principle of idempotency. The server cannot know when a user id is no longer in use, because we have no "log out" endpoint and even if we had one the client could crash and thus not send out a "log out" message. Instead we assume that all clients are well behaved and use GetUserToken to get a token that is not in use. Co-authored-by: CasperStaahl <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are many public facing structs and functions without documentation.
We should at least have a short description, but even better have doctest examples of usage for functions.
We should also have documentation for "large" private helper functions.
The text was updated successfully, but these errors were encountered: