Skip to content

Correct method documentations #70

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

Open
dancojocaru2000 opened this issue Mar 23, 2019 · 3 comments
Open

Correct method documentations #70

dancojocaru2000 opened this issue Mar 23, 2019 · 3 comments

Comments

@dancojocaru2000
Copy link

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
Copy link
Member

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
Copy link
Member

zmeyc commented Jun 3, 2020

@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
Copy link
Member

cipi1965 commented Jun 3, 2020

@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

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

No branches or pull requests

3 participants