Skip to content
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

Update README.rst Tishanth #87

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TishanthP
Copy link

Comments can explain your thought process through the project, so you should add some to further explain each link and line in your code, and what purpose it has, and only if it seems that complicated.

@zjkmxy
Copy link
Member

zjkmxy commented Oct 17, 2024

Sorry but I don't understand what do you mean.
If you have concerns about our documentation, which I know lacks a lot of details, could you please point to the specific document page that you want to be improved?
README.rst is only the entrance to hold badges and a link to the real documentation. I don't see any need to explain this file.

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

Successfully merging this pull request may close these issues.

2 participants