Skip to content

Commit

Permalink
First stab at documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
drupol committed Dec 29, 2019
1 parent 8178972 commit a847123
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ This library is framework agnostic and can be integrated in any PHP project, in
Requirements <pages/requirements>
Installation <pages/installation>
Usage <pages/usage>
API <pages/api>
Tests <pages/tests>
Contributing <pages/contributing>
Development <pages/development>
112 changes: 112 additions & 0 deletions docs/pages/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
API
===

append
------

.. code-block:: php
$collection = Collection::with(['1', '2', '3']);
$collection
->append('4'); // ['1', '2', '3', '4']
$this
->append('5', '6'); // ['1', '2', '3', '5', '6']
apply
-----

chunk
-----

collapse
--------

combine
-------

distinct
--------

explode
-------

filter
------

flatten
-------

flip
----

forget
------

intersperse
-----------

keys
----

limit
-----

map
---

merge
-----

normalize
---------

nth
---

only
----

pad
---

pluck
-----

prepend
-------

rebase
------

reduction
---------

reverse
-------

skip
----

slice
-----

sort
----

split
-----

tail
----

until
-----

walk
----

zip
---

0 comments on commit a847123

Please sign in to comment.