Skip to content
New issue

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

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

Already on GitHub? # to your account

Add docs for :<- #544

Closed
yochannah opened this issue Aug 27, 2019 · 3 comments
Closed

Add docs for :<- #544

yochannah opened this issue Aug 27, 2019 · 3 comments
Assignees

Comments

@yochannah
Copy link

:<- seems to possibly be an undocumented feature - it appears here: https://github.com/Day8/re-frame/blob/master/examples/todomvc/src/todomvc/subs.cljs#L127 as part of the todo app example, but I'm not sure where it's documented, if anywhere.

It's also possible the docs exist but are hard to find, since GitHub and Google don't really like searching for punctuation. Is there some way to mitigate this? I'm guessing possibly not, short of renaming it and breaking backwards compatibility.

@mainej
Copy link

mainej commented Aug 27, 2019

There's an explanation on the docstring for reg-sub. But agreed, I don't see it in the main docs, and it's hard to search for.

@milt
Copy link
Contributor

milt commented Aug 27, 2019

👍 I used re-frame for so long before I found that tasty bit of sugar. Definitely belongs in the docs.

@superstructor
Copy link
Contributor

This issue has now been addressed in three ways:

  • All core functions now have doc strings which appear in the new API documentation. The doc string for regsub explains :<-. This change will make it easier for programmers to discover and understand this feature.
  • The new re-frame tutorial will have a textual search facility (allowing you to find :<- more easily)
  • The part of the tutorial for subscriptions is currently being improved and now discusses this feature directly (will be released soon)

Closing.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants