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

Help to fill documentation #142

Open
InsanusMokrassar opened this issue Oct 2, 2020 · 10 comments
Open

Help to fill documentation #142

InsanusMokrassar opened this issue Oct 2, 2020 · 10 comments
Labels
api There are changes in TelegramBotAPI-extensions-api core There are changes in TelegramBotAPI Hacktoberfest utils There are changes in TelegramBotAPI-extensions-utils

Comments

@InsanusMokrassar
Copy link
Owner

InsanusMokrassar commented Oct 2, 2020

Currently, not the whole code is filled with KDocs. In case you wish to work on this issue, it could be useful to know:

  • Gradle command dokkaHtmlMultiModule will build kotlin documentation (in linux terminal: ./gradlew dokkaHtmlMultiModule, in windows probably: ./gradlew.bat dokkaHtmlMultiModule)
  • The most important to cover with kdocs is core
  • API Extensions subproject could be filled with kdocs like analogue of (here method from telegram bot api) with differences in (differences) (Telegram Bot API)[https://core.telegram.org/bots/api]
@InsanusMokrassar InsanusMokrassar added api There are changes in TelegramBotAPI-extensions-api utils There are changes in TelegramBotAPI-extensions-utils core There are changes in TelegramBotAPI Hacktoberfest labels Oct 2, 2020
@trylinka
Copy link

trylinka commented Oct 2, 2020

Hey, @InsanusMokrassar!
Could you please assign it to me?

@InsanusMokrassar
Copy link
Owner Author

Sure

@trylinka
Copy link

trylinka commented Oct 2, 2020

@InsanusMokrassar, thanks!

@InsanusMokrassar
Copy link
Owner Author

@trylinka could you say, when do you plan to start work on it?:)

@trylinka
Copy link

trylinka commented Oct 3, 2020

@InsanusMokrassar, plan to start working with it these weekends, is it suitable for you?
well, as soon as possible :)

@InsanusMokrassar
Copy link
Owner Author

@InsanusMokrassar, plan to start working with it these weekends, is it suitable for you?
well, as soon as possible :)

Of course, thank you :)

@InsanusMokrassar
Copy link
Owner Author

@trylinka Hello:) is there any progress on this issue? Maybe you need some help or explanations for some points in library?

@InsanusMokrassar
Copy link
Owner Author

@trylinka Hello :) excuse me, but in case of your inactivity on this issue I will have to unassign it

@trylinka trylinka removed their assignment Oct 13, 2020
@tetianasteblova
Copy link

hi, @InsanusMokrassar is this task is still actual? I checked some links - they are not active anymore

@InsanusMokrassar
Copy link
Owner Author

hi, @InsanusMokrassar is this task is still actual? I checked some links - they are not active anymore

Hi and thank you for your interest :) I have updated description of task, so now it must be actual

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api There are changes in TelegramBotAPI-extensions-api core There are changes in TelegramBotAPI Hacktoberfest utils There are changes in TelegramBotAPI-extensions-utils
Projects
None yet
Development

No branches or pull requests

3 participants