New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Probably outdated documentation #231

Closed
hossameldeen opened this Issue Apr 29, 2015 · 4 comments

Comments

Projects
None yet
2 participants
@hossameldeen
Contributor

hossameldeen commented Apr 29, 2015

In (Graphics.Input & Graphics.Input.Field)'s documentation, there seems to be referring to Signal.Channel a lot, like in the first line here, and actually all over the examples:
http://package.elm-lang.org/packages/elm-lang/core/2.0.1/Graphics-Input

The API definition seems to be correct, though.

Graphics.Input.Field documentation page:
http://package.elm-lang.org/packages/elm-lang/core/2.0.1/Graphics-Input-Field

Unfortunately, I'm not comfortable enough yet with Signal.Message to fix it myself.

@jvoigtlaender

This comment has been minimized.

Show comment
Hide comment
@jvoigtlaender

jvoigtlaender Apr 29, 2015

Contributor

The changes would be very mechanical:

  • Signal.Channel becomes Signal.Mailbox
  • Signal.channel becomes Signal.mailbox
  • Signal.subscribe x becomes x.signal
  • Signal.send x becomes Signal.message x.address

That should be it.

Contributor

jvoigtlaender commented Apr 29, 2015

The changes would be very mechanical:

  • Signal.Channel becomes Signal.Mailbox
  • Signal.channel becomes Signal.mailbox
  • Signal.subscribe x becomes x.signal
  • Signal.send x becomes Signal.message x.address

That should be it.

@hossameldeen

This comment has been minimized.

Show comment
Hide comment
@hossameldeen

hossameldeen Apr 29, 2015

Contributor

Done with the mechanical steps. If anyone could review again before sending the PR, that'd be nice. Or should I send the PR directly since I've reviewed? (Excuse me, still learning the etiquette)

The new Graphics.Input.elm: https://github.com/hossameldeenfci/core/blob/patch-1/src/Graphics/Input.elm
The new Graphics.Input.Field.elm: https://github.com/hossameldeenfci/core/blob/patch-2/src/Graphics/Input/Field.elm

Contributor

hossameldeen commented Apr 29, 2015

Done with the mechanical steps. If anyone could review again before sending the PR, that'd be nice. Or should I send the PR directly since I've reviewed? (Excuse me, still learning the etiquette)

The new Graphics.Input.elm: https://github.com/hossameldeenfci/core/blob/patch-1/src/Graphics/Input.elm
The new Graphics.Input.Field.elm: https://github.com/hossameldeenfci/core/blob/patch-2/src/Graphics/Input/Field.elm

@jvoigtlaender

This comment has been minimized.

Show comment
Hide comment
@jvoigtlaender

jvoigtlaender Apr 30, 2015

Contributor

Looks good, just one change missing, in this line: the Markdown link to send should now probably go to message as well.

I think it's okay to send the PR then.

Contributor

jvoigtlaender commented Apr 30, 2015

Looks good, just one change missing, in this line: the Markdown link to send should now probably go to message as well.

I think it's okay to send the PR then.

@hossameldeen

This comment has been minimized.

Show comment
Hide comment
@hossameldeen

hossameldeen Apr 30, 2015

Contributor

Edited. Sent the PR.

Contributor

hossameldeen commented Apr 30, 2015

Edited. Sent the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment