Flutter_blue: [iOS] Connect options

Created on 5 Mar 2018  路  4Comments  路  Source: pauldemarco/flutter_blue

Most helpful comment

The public API should have at least basic documentation stating the purpose of the parameter. That literarily takes seconds per method and can be picked up when typing the code by the user of the API. I could not decipher it from the code what the parameter of connect is doing e.g, It probably takes more time to answer questions for you about the purpose of a method parameter. The same is valid for regression testing.

I will be frank, this is bad practice. There is always a reason for postponing it. Same for refactoring and regression testing.

I guess I am also in a bad mood by wasting tons of time getting this package to run on IOS

All 4 comments

Even the option right now in the API of connecting has no documentation. (Delay and Autoconnect)
In the code, it states it is Android only. In general, it would be nice to have a proper API documentation

Documentation is not near where I鈥檇 like it to be. The code will have to serve as the documentation until the API is more baked.

The public API should have at least basic documentation stating the purpose of the parameter. That literarily takes seconds per method and can be picked up when typing the code by the user of the API. I could not decipher it from the code what the parameter of connect is doing e.g, It probably takes more time to answer questions for you about the purpose of a method parameter. The same is valid for regression testing.

I will be frank, this is bad practice. There is always a reason for postponing it. Same for refactoring and regression testing.

I guess I am also in a bad mood by wasting tons of time getting this package to run on IOS

A separate issue has been opened to track documentation:
https://github.com/pauldemarco/flutter_blue/issues/533

Was this page helpful?
0 / 5 - 0 ratings