-
Notifications
You must be signed in to change notification settings - Fork 18
Docs/update #69
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.
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
Docs/update #69
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually I would vote for more accurate use of ChatGPT. The docs I've seen in this pull request are mostly unneccessively long and general. I believe we really should point out the crucial and important things about our framework, some our inventions, breaking functionality or use cases and give links to the rest.
Here I could see very general explanations of what e.g. pipelinie does, not telling user anything actually and detailed description of what MongoDB actually is. That's just not what docs are made for. I guess we should be more clear and precise, not more wordy.
I would also like to specially mention the overuse of unnecessary and common adjectives like "powerful", "common", "popular", "fast", etc. I don't think we should advertise DFF (or any other solution) in docs - we should write clearly and simply the necessary things about what we have done. That might fit in index.rst, why not, but not the docstrings. That's great if we have conducted some analysis (which I haven't heard of) showing that our solution is "fast", "secure" or "powerful" (I actually don't even know what exactly a "powerful solution" is), but in that case we'd better shown the numbers, the statistics or something like that and not bragged with general and therefore meaningless words.
What do you think about that?
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- change naming
ToCtoTable of Content -
dff.messengers.telegramto some thing likeTG interface
Description
This PR expands the description of the modules. A description of each item in the tocs is given.
Checklist