Skip to content

Conversation

@avsakharov
Copy link
Contributor

@avsakharov avsakharov commented Jan 18, 2023

Description

This PR expands the description of the modules. A description of each item in the tocs is given.

Checklist

  • I have covered the code with tests
  • I have added comments to my code to help others understand it
  • I have updated the documentation to reflect the changes
  • I have performed a self-review of the changes

@avsakharov avsakharov added the documentation Improvements or additions to documentation label Jan 20, 2023
Copy link
Collaborator

@pseusys pseusys left a 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?

avsakharov and others added 18 commits February 2, 2023 17:36
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
Co-authored-by: Kuznetsov Denis <[email protected]>
@avsakharov avsakharov requested a review from kudep February 10, 2023 09:34
Copy link
Collaborator

@kudep kudep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • change naming ToC to Table of Content
  • dff.messengers.telegram to some thing like TG interface

@kudep kudep merged commit fcb6096 into dev Feb 14, 2023
@kudep kudep deleted the docs/update branch February 14, 2023 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants