status-im
/
re-frame
mirror of https://github.com/status-im/re-frame.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Towards API docs

This commit is contained in:
Mike Thompson 2017-07-21 01:14:07 +10:00
parent 7556f67319
commit 34ccd4b272
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/API.md
View File

@ -1,14 +1,16 @@
## re-frame API
> Page Under construction
I have good news and bad news.
## The re-frame API
So, I have some good news and some bad news.
First, the bad news:
1. [there's this problem](https://github.com/Day8/re-frame/blob/master/src/re_frame/core.cljc#L19-L33)
2. I lied about the extra nudity
Now, the good news:
1. the re-frame API is indeed [all in one namespace](https://github.com/Day8/re-frame/blob/master/src/re_frame/core.cljc)
2. That namespace has occasional comments
1. the re-frame API is indeed [all in the core namespace](https://github.com/Day8/re-frame/blob/master/src/re_frame/core.cljc)
2. That namespace has some comments
3. Each API function has passable documentation (see links below), just not auto-generated.
## Links To API docs
@ -23,7 +25,7 @@ Occasionally, you'll need to use:
- [reg-fx]()
- [reg-cofx]() and [inject-cofx]()
And, finally, there are some standard Interceptors:
And, finally, there are some builtin Interceptors:
- [path]()
- [after]()
- [debug]()