Skip to content

Improve and clarify doc comments for public API #230

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Improve and clarify doc comments for public API #230

wants to merge 6 commits into from

Conversation

@steindvart
Copy link
Contributor

@steindvart steindvart commented Oct 30, 2025 •
edited
Loading

Problem

Solution - what PR does

  • Improved documentation for many public API entities of library, for clarification of behavior and reflection of key features of a particular entity.
  • Uniformed and clarified links to Telegram API docs: See Telegram API docs: <URL>.
  • Removed unused or redundant comments in common.go.
  • Turned var to const where is possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve and clarify doc comments for public API

1 participant

@steindvart