Skip to content
This repository has been archived by the owner on Nov 21, 2023. It is now read-only.

Lack of documentation #31

Closed
redmie opened this issue Mar 28, 2022 · 1 comment
Closed

Lack of documentation #31

redmie opened this issue Mar 28, 2022 · 1 comment

Comments

@redmie
Copy link
Contributor

redmie commented Mar 28, 2022

Many functions have cryptic names like get_md_mf or last_usn for example.

It makes code maintenance hard as one struggles to find the function usage.
We should document what function does what and maybe explain the server architecture in a markdown file in docs/.

Could you help me on that @dobefore as you are the main contributor of the original server logic?

@dobefore
Copy link
Collaborator

dobefore commented Mar 29, 2022

Many functions have cryptic names like get_md_mf or last_usn for example.

this is the truuth.I wll rename those functions and variables whose meanings are unclear like get_md_mf ,yet some are from anki lib ,although,I'll try to make it.

We should document what function does what

this is what I am planning to do.I guess this is part of function comments with \\\?

explain the server architecture in a markdown file in docs/

first,I describe the server architure in plain text ,then,If possible,can you re-process the material?

Add: #45

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

2 participants