search

Danp2 / au3WebDriver

Web Driver UDF for AutoIt
MIT License
107 stars 23 forks source link

Standardize method of documenting errors in function headers #458

Open Danp2 opened 1 year ago

Danp2 commented 1 year ago

See prior discussion in https://github.com/Danp2/au3WebDriver/issues/444

mlipok commented 1 year ago

Prior discussion was not closed. So what this new ISSUE is intended to do in a different way than prior discussion ?

Danp2 commented 1 year ago

I never indicated that it was closed. I simply referenced it for the value it already contains. If you read the prior discussion, then it should be clear why I opened this separate PR. Let me know if you still don't understand, and I will explain further.

Danp2 commented 1 year ago

Some related discussions --

https://github.com/Danp2/au3WebDriver/issues/444#issuecomment-1478234688

https://github.com/Danp2/au3WebDriver/issues/437

Also, this is from the wiki --

Return values

Details what is returned by the function. This often comes in the form of Success and Failure values, but this is not always the case. Any setting of the @error of @extended flags should be detailed, along with their meanings, in some cases it is enough to say that @error is set to non-zero in the event of an error, in most cases though a list of values for @error should be given.