DOKUMENTATION
We have currently no place, where we can direct an interested user to checkout in a conveniant way the reportoir of saqc funcs and get more detailed information on their parameters.
- readTheDocs -> this would be the place.
- Currently, among the test functions, there are listed all lib.tools as i could say from a glimpse. Thats really confusing for anyone who just wants to know what he can do with his data. Also, because the lib.tools func names are more cryptic/programming specific, its unsettling to look around there, because from every second function you dont get its purpose.
- Also some functions are missing, due to syntax errors i guess.
- the docs/funcs directory in the repo: I find this directory in its current state totally not reliable - i would not recommend a user, or a going-to-be user, to search it for proper tools. A lot of tests are missing, and a lot of signatures are outdated -> so looking up things there might result in frustrating experiences.
I find the issue quite urgend, because: you can not make comprehensive to one, who is interested, what saqc is capable of and also you can not send one to a central space, where the how-to-knowledge and with-what-knowledge is gathered.
So i guess we should finalize and polish our readTheDoc appearence.
Also, i fear, we need another doku week sooner or later, because the language seems not to be well understandable for saqc outsiders. The problem doesnt seem to be the mathematical formulas, but the vocabulary that relates to saqc or pandas or python mechanics, such as "dios", "dataframe", "field" and also "replace" - accessing saqc on the config level as a user, you dont have a thing called the "dios" or the "field", you more think in terms of, "the data that i want to be flagged", the variables i want to flag" and the valiable i want to add to my data and so on. Or maybe in "columns" and "rows". I think the (funcs) docu is still too much aimed at ourselfs, as people operating inside saqc/python.