Commit Graph

28 Commits

Author SHA1 Message Date
Johannes Fahrenkrug
5e2e7e3a75
Documentation: Clarify when promise body gets executed 2019-11-15 11:57:38 -05:00
Johannes Fahrenkrug
8fbf6985b4
Documentation: Clarify when a promise "starts" in the FAQ
Provide a simpler exlanation and examples about when promises "start".
Make it clear that the promise's body executes after the promise is created,
without the need to call `then` or `done` on it. Also clarify that async
tasks that a being kicked off from a promise's body behave the same way
regardless of whether PromiseKit is being used or not.
2019-11-15 11:39:21 -05:00
Max Howell
91f002f6f6
mxcl.github.io|promisekit.org -> mxcl.dev
* Fixes broken links
* Corrects spelling

[skip ci]
2019-03-01 00:02:04 -05:00
Ricardo Santos
662ce62593 Fix typo 2019-02-28 09:25:11 +10:30
Max Howell
358ed97c6d
Update Logging FAQ 2018-12-04 18:52:56 -05:00
Neal Lester
a5ab1ea5b3 Added facilities for controlling console output
Refs #961
2018-12-04 14:48:58 -05:00
Max Howell
d6f24e2b0d
Update server-side suggestions 2018-08-15 16:12:49 -04:00
Max Howell
ca0c4e6369
[FAQ] How do I create a fulfilled Void promise?
[ci skip]
2018-07-23 12:12:53 -04:00
Max Howell
e50702aa12
[FAQ] How do I early return?
[ci skip]
2018-07-23 12:11:25 -04:00
Garth Snyder
2b88cac8e0 Doc headings to title case, no Oxford commas 2018-06-27 10:50:56 -07:00
Garth Snyder
caa3322070 Minor copy editing of RxSwift section 2018-06-27 10:50:56 -07:00
Garth Snyder
fecf4f8430 Documentation copy editing, add more RxSwift info, fix asVoid() example 2018-06-17 15:37:09 -07:00
Max Howell
e2d8a05dab FAQ about who retains what 2018-06-01 12:04:28 -04:00
Garth Snyder
1af7599572 Copy editing for FAQ.md 2018-05-30 17:46:32 -07:00
Colin T.A. Gray
6f20a190c3 Allow setting nil for conf.Q 2018-04-04 23:21:26 -04:00
Max Howell
4c1e1ca29a [ci skip] Mention that we validate against Promises/A+ 2018-02-20 18:05:54 -05:00
Lukas Schmidt
d94e3be9bb Adds missing comma to the FAQ (#785)
Adds missing comma…

…in the list of all supported platforms mentioned in the FAQ
2018-02-18 17:29:15 -05:00
Max Howell
b585f7cdc7 [ci skip] Update FAQ 2018-02-18 17:29:10 -05:00
Wayne Hartman
a9cf4b71a6 FAQ spelling and grammar corrections 2018-02-18 15:10:50 -05:00
Max Howell
673ce2d4f9 [ci skip] Docs++ WIP 2018-02-13 16:44:01 -05:00
Max Howell
17587be4ac PromiseKit 6.0.0
This because `Promise(value:)` is selected for PMK-4’s pending initializer due to trailing closure syntax and the fact that `T` could be anything. I guess this isn’t a Swift bug, but geez.

This is a real problem for people migrating to 5 from 4, such that I have decided 5 must be deprecated.

The severity is due to Swift giving a very misleading error diagnostic when it uses `Promise(value:)`, because as you can guess you end up with:

    Promise<(T->Void, Error->Void)>

As your inferred type.

Because we no longer have ambiguity between `Promise { seal in` and `Promise(value:` I have removed the `.pending` parameter for that usage which will also aid migration.

In some cases this leads to less nice code, but mostly it’s fine due to being able to do `.value(1)` where `Promise` can be inferred. The trade off is worth it though as PromiseKit should be delightful to use and as it stands, it is a pain due to how Swift is.
2018-02-10 17:23:27 -05:00
Semen Zhydenko
102fe659e4 heirarchy -> hierarchy 2018-02-03 14:07:05 +01:00
Max Howell
d01c2d1df2 Talk more about retain-cyles and side-effects 2017-11-30 11:44:49 -05:00
Max Howell
77f2c90b53 Clarify servers-side usage; Refs #627 2017-11-30 11:38:03 -05:00
Max Howell
49ca5abcc7 Update FAQ.md 2017-10-14 11:49:13 -04:00
Carlos Cuba
1f9d28d699 Update FAQ.md
There was a typo on the last section of the document.
Thanks for this great framework!
2017-10-11 00:23:52 -05:00
Max Howell
f27cc55a8f Firebase and Promises
Refs #716
2017-09-29 10:49:33 -04:00
Max Howell
212f31f418 Move documentation to master 2017-06-26 15:40:13 -04:00