rapierorg / telegram-bot-swift

Telegram Bot SDK for Swift (unofficial)
https://github.com/rapierorg/telegram-bot-swift/wiki
Apache License 2.0
375 stars 63 forks source link

Correct method documentations #70

Open dancojocaru2000 opened 5 years ago

dancojocaru2000 commented 5 years ago

I'm not sure how method documentations are written/generated, but the Swift parameters are camelCased while the documentation parameters are underline_separated, which makes the documentation not show up in xCode.

Here's an example: image image

cipi1965 commented 5 years ago

Ok this is a bug in generator from last update where we changed parameters and method naming to camelCase as per Swift naming standard, we are in the process of rewriting the library completely so we can’t fix it right now, do you agree @zmeyc?

Sent with GitHawk

zmeyc commented 4 years ago

@cipi1965 We were generating docs from TG docs, but since we switched to schema it's impossible to sync docs now. So we can only document a few of our own methods... Best we can do is to link to original TG methods if they have anchors.

cipi1965 commented 4 years ago

@zmeyc since documentation links are simply https://core.telegram.org/bots/api#type-or-method-name we could at least set in in our generation? And document our non-generated methods