search

GEWIS / sudosos-backend

SudoSOS is a Node.js-based Bar and POS system made for study association GEWIS.
https://sudosos.gewis.nl
GNU Affero General Public License v3.0
6 stars 3 forks source link

[Chore] Add extra documentation to User's `active` and `deleted` attributes #348

Open Yoronex opened 1 month ago

Yoronex commented 1 month ago

What would you like?

See title

Why is this needed?

There is constant confusion as to what these attributes exactly mean. At the ABC SudoSOS meeting, we decided on the following (Dutch) definitions:

  • Inactive: mensen die alleen kunnen inloggen en opwaarderen (bijvoorbeeld voor afgestudeerden die nog een schuld hebben).
  • Deleted: soft-deleted users als het saldo exact 0 is.

How could it be implemented?

Explicit JSdoc for these entities including examples, which should also be compiled to the new Typedoc.

Other information

No response