Commit graph

9 commits

Author SHA1 Message Date
jeop10
b166528853 Update Getting Started.md
Summary:
Update Getting Started file to display that 'IGListDiffable' has been renamed to 'ListDiffable' (as seen on Xcode)

Issue fixed: N/A

- [ ] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [X] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/964

Differential Revision: D6161503

Pulled By: rnystrom

fbshipit-source-id: a3602393bb29a31d05fd9590aaa44f03bd5827d7
2017-10-26 10:42:37 -07:00
Clay Reimann
85afdfa54b Make explicit IGListDiffable protocol requirement
Summary:
While the CocoaDocs for the [IGListDiffable](https://instagram.github.io/IGListKit/Protocols/IGListDiffable.html) state that IGListDiffable objects should not mutate their `diffIdentifier` that requirement is not clear in this guide.

This is a documentation only PR.

Issue fixed: #880

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/881

Reviewed By: ryanolsonk

Differential Revision: D5547277

Pulled By: rnystrom

fbshipit-source-id: 68d6f18f9c5bbb28d2c7071b67e8f89624258d81
2017-08-03 06:12:51 -07:00
Weyert de Boer
9f5bf3fb7e Improved the documentation
Summary:
Improved the documentation so it that the Getting Started guide calls out that you need to set `dataSource`-property of the `IGListAdapter` as I totally misse that.
Closes https://github.com/Instagram/IGListKit/pull/820

Differential Revision: D5353295

Pulled By: rnystrom

fbshipit-source-id: deca1d75fad08f69081033ae1a65302a4f10ba9f
2017-06-29 18:32:31 -07:00
James Sherlock
fb5dd116a2 Spelling & General Fixes
Summary:
Closes #771, #768, #767, #766, #765
Closes https://github.com/Instagram/IGListKit/pull/789

Differential Revision: D5129348

Pulled By: rnystrom

fbshipit-source-id: 4f3da39e643adade99fa7549098ff39d6350de17
2017-05-25 08:03:37 -07:00
Ryan Nystrom
b6217a6709 Proof guides for consisntency and name changes
Summary:
Part of #707
Closes https://github.com/Instagram/IGListKit/pull/730

Differential Revision: D5039060

Pulled By: rnystrom

fbshipit-source-id: d54259b2dddbaba0fe2e69c6dd08a37fd17fbc4a
2017-05-10 13:31:19 -07:00
Ryan Nystrom
ad416ecccd Remove refs to IGListSectionType, fix TV app example
Summary:
- Clean up docs
  - Remove `IGListSectionType` and `IGListCollectionView`
- Fix TV app example

Issue fixed: #675

- [x] All tests pass. Demo project builds and runs.
Closes https://github.com/Instagram/IGListKit/pull/676

Differential Revision: D4915634

Pulled By: rnystrom

fbshipit-source-id: 60eb1f1e5ece7fe68f6bf44b465bd5379615d716
2017-04-19 16:21:07 -07:00
Jesse Squires
fb5f15ed5e Core Data guide
Summary:
Issue answered: #407 #460 #461

I did not run any tool to generate documentation

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/515

Differential Revision: D4621212

Pulled By: jessesquires

fbshipit-source-id: 110e3d37d08e7c763b6a6cde70bc83280f7a2bb3
2017-02-27 11:31:55 -08:00
LinkThrow
552053a5da Broken link to full 'LabelSectionController.swift'
Summary:
- [ ] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)

Replaced with direct link in repo
Closes https://github.com/Instagram/IGListKit/pull/254

Differential Revision: D4231946

Pulled By: rnystrom

fbshipit-source-id: 75635e12cd8f4f047d8afc0d6dd6008136bd5d26
2016-11-24 10:29:04 -08:00
Jesse Squires
8a6fde9e45 Initial setup for guides
Summary:
- Create `Guides/` top-level dir
- Move `README` "creating first list" contents into `Guides/Getting Started.md`
- Add initial `Guides/Migration.md` (ref #221)
- Fix #245

See rendered guides at:

- https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md
- https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md
Closes https://github.com/Instagram/IGListKit/pull/252

Differential Revision: D4228332

Pulled By: jessesquires

fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 12:44:01 -08:00