Document internal functions

Hugovdberg commented 6 years ago

Types of change

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Other (documentation etc)

Pull request checklist

[ ] Add functionality
[ ] Add tests
[x] Update documentation in man
[ ] Update website documentation

Proposed changes

As mentioned in #238 a lot of internal function lack documentation. This weekend I spent some time looking over all code, and besides a few anonymous functions all functions are documented now.

I also collapsed the documentation for all readers into a single file (with the preinstalled.readers list). Also, the specific documentation for the separate readers is a lot more compact now. To see the new index you need to install this branch and click on the index link at the bottom of any ProjectTemplate help page.

Unfortunately I couldn't mark all readers as internal while keeping the list in the index, without adding files that would need manual updating for new readers (which would inevitably lead to missing out readers etc.). I did put a link to the preinstalled.readers page in the ProjectTemplate-package file.

I'm sorry I touched almost every file in the R directory and created a whole lot of new files in the man directory, but I didn't change functionality so I don't expect too much work for review.

KentonWhite commented 6 years ago

@Hugovdberg can you check the conflicts in the description file. It looks like this was created before the feather reader was merged. I am assuming that feather should be appended to the Collate list?

Hugovdberg commented 6 years ago

I did the two simultaneously, knowing this would eventually lead to a conflict for one of the two, but I thought it better to keep the two requests separated and merge the conflicts manually. I'll fix it later tonight, I will also make the feather.reader documentation fit in with the new reader documentation.

Hugovdberg commented 6 years ago

Whoops, messed up my commit history once again. I keep mixing up git pull and git fetch+git rebase. All signatures changed because I rebased on top of upstream/master, but I only changed the feather.reader documentation.

Hugovdberg commented 6 years ago

Current status: https://travis-ci.org/KentonWhite/ProjectTemplate/requests Regarding the error message: https://github.com/yiisoft/yii2/issues/14517

Could it be Travis is waiting for an approving review?

KentonWhite commented 6 years ago

Finished the review. Lets see if that prompts travis to run checks!

rsangole commented 6 years ago

As a matter of practice, are you (we) deleting branches after bug fixes, or feature additions?

If yes, we can get rid of quite a few stale branches from the repo which are just lingering.

KentonWhite commented 6 years ago

We should prune stale branches. Haven't been doing it so they are piling up.

KentonWhite commented 6 years ago

I've removed the stale branches

KentonWhite / ProjectTemplate