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

docs: Clarify DC_EVENT_INCOMING_WEBXDC_NOTIFY documentation #6249

Merged
merged 1 commit into from
Nov 23, 2024

Conversation

Hocuri
Copy link
Collaborator

@Hocuri Hocuri commented Nov 23, 2024

I found the old documentation rather hard to understand. The new doc string:

  • uses whole sentences, leaving less space for misinterpretation
  • explicitly mentions that it can happen that there is no webxdc-info-message
  • is clearly structured using bullet points.

I didn't understand what "in case of summary change" means, maybe this needs to be added to the new doc string.

@Hocuri Hocuri requested a review from r10s November 23, 2024 13:43
Copy link
Member

@r10s r10s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

the new "Sometimes no webxdc-info-message is added to the chat" explains the "summary change" much better (the situation happens when an update changes update.summary but not update.info at the same time)

@Hocuri Hocuri merged commit daeeca3 into main Nov 23, 2024
38 checks passed
@Hocuri Hocuri deleted the hoc/clarify-notify-docs branch November 23, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants