Coder Social home page Coder Social logo

[iOS] Connect options about flutter_blue HOT 4 OPEN

pauldemarco avatar pauldemarco commented on July 3, 2024
[iOS] Connect options

from flutter_blue.

Comments (4)

ride4sun avatar ride4sun commented on July 3, 2024 2

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

from flutter_blue.

pauldemarco avatar pauldemarco commented on July 3, 2024 1

A separate issue has been opened to track documentation:
#533

from flutter_blue.

ride4sun avatar ride4sun commented on July 3, 2024

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

from flutter_blue.

pauldemarco avatar pauldemarco commented on July 3, 2024

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

from flutter_blue.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.