• Martin Kustermann's avatar
    Improve documentation of `compute()` function (#116878) · fc3571ef
    Martin Kustermann authored
    This improves the documentation of the `compute()` function as follows:
    
      * Instead of making `compute` a top-level constant, we make it a
        function. This allows the generated API docs to show a function
        signature with parameters and their names, making it *much* clearer
        to users what function is being documented.
    
      * We mention that on web-backends this is running `compute()` on the
        normal eventloop whereas on on native platforms it runs in a
        separate isolate.
    
      * We mention that callback, message and result have to be sendable
        across isolates. We also mention that they may be copied.
    
      * We link to both `Isolate.run` & `SendPort.send` for more information.
    
      * We use `M` for the type of `message` instead the rather confusing
        `Q`.
    fc3571ef
Name
Last commit
Last update
.github Loading commit data...
bin Loading commit data...
dev Loading commit data...
examples Loading commit data...
packages Loading commit data...
.ci.yaml Loading commit data...
.cirrus.yml Loading commit data...
.gitattributes Loading commit data...
.gitignore Loading commit data...
AUTHORS Loading commit data...
CODEOWNERS Loading commit data...
CODE_OF_CONDUCT.md Loading commit data...
CONTRIBUTING.md Loading commit data...
LICENSE Loading commit data...
PATENT_GRANT Loading commit data...
README.md Loading commit data...
TESTOWNERS Loading commit data...
analysis_options.yaml Loading commit data...
dartdoc_options.yaml Loading commit data...
flutter_console.bat Loading commit data...