google / promises

Promises is a modern framework that provides a synchronization construct for Swift and Objective-C.
Apache License 2.0
3.8k stars 293 forks source link

Fix typo #33

Closed BenEmdon closed 6 years ago

BenEmdon commented 6 years ago

I was reading the docs and I stumbled upon a code block difference between Swift and Obj-c where the docs refers to a function processData but in the Swift block it was only process.

googlebot commented 6 years ago

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers
BenEmdon commented 6 years ago

I signed it!

googlebot commented 6 years ago

CLAs look good, thanks!

shoumikhin commented 6 years ago

Thanks, Ben!

I suspect the idea was that a corresponding Swift method would be called simply process per naming convention, and have the following prototype:

func process(_ data: Data)

And used directly as:

process(data)

But some extra clarity, which processData adds to the example, is also good.

BenEmdon commented 6 years ago

Ah, that is more Swifty. I guess referring to the different function signatures in documentation sentences can be a mouthful. I’m curious what other Swift/Obj-C docs do?

Sent with GitHawk

shoumikhin commented 6 years ago

I'd be great if GitHub markdown supported language toggling. Something like Firebase has for their docs.

BenEmdon commented 6 years ago

I'll put in a word when I'm there this summer 😉

shoumikhin commented 6 years ago

Awesome! Congrats on a new role - GitHub's great :)