Skip to content

Document that answerChatJoinRequestQuery.result can be null - #3752

Open
alyral wants to merge 1 commit into
tdlib:masterfrom
alyral:master
Open

alyral wants to merge 1 commit into
tdlib:masterfrom
alyral:master

Conversation

@alyral

@alyral alyral commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

As the title says; parameters/fields which can be null are usually marked as such in the TL schema documentation, but this one seems to be an exception.

@levlam

levlam commented Sep 28, 2026

Copy link
Copy Markdown
Contributor

Any parameter of a request may be null, which may or may not form a valid request depending on other request parameters. If passing a null as a parameter has specific behavior, then this parameter may be documented as "; pass null (if|to) ...", but not as "; may be null". In the case of this method it may be documented that null must be passed as the parameter if url is passed and vice versa.

@alyral

alyral commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Any parameter of a request may be null, which may or may not form a valid request depending on other request parameters. If passing a null as a parameter has specific behavior, then this parameter may be documented as "; pass null (if|to) ...", but not as "; may be null". In the case of this method it may be documented that null must be passed as the parameter if url is passed and vice versa.

What about the following then?

//@result The result; must be null if a URL is passed
//@url URL of the Web App to open; must be null if a result is passed

This branch has not been deployed

No deployments
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

Successfully merging this pull request may close these issues.

2 participants