Replies: 2 comments 2 replies
-
|
The description in the readme is auto-generated from package documentation. You need to add the relevant documentation for it to appear in the README. |
Beta Was this translation helpful? Give feedback.
-
|
@raklaptudirm Sorry, I didn't quite catch that. Could you please elaborate? |
Beta Was this translation helpful? Give feedback.
-
|
In Go, you write package documentation as comments. We use an automatic tool which populates the readme with this documentation. The package lacks proper documentation if the documentation is missing from the README. Therefore, you will have to add the missing documentation to the package and it will be automatically added to the README. |
Beta Was this translation helpful? Give feedback.
-
|
ok got it! Thanks |
Beta Was this translation helpful? Give feedback.
-
The description in readme file for segmenttree seems to be missing. I wanted to contribute to it. How can I do it? Should I create an issue first or directly create a PR ?
Beta Was this translation helpful? Give feedback.
All reactions