Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

add further documentation #44

Merged
merged 6 commits into from May 10, 2019
Merged

Conversation

@AdamSpannbauer
Copy link
Contributor

@AdamSpannbauer AdamSpannbauer commented May 6, 2019

adds roxygen2 style documentation for package to address #43

Spannbauer, Adam M and others added 3 commits May 6, 2019
Spannbauer, Adam M
Copy link
Owner

@eddelbuettel eddelbuettel left a comment

That looks straightforward enough.

As a general viewpoint, I do not believe in replacing working setups just for the sake of making changes. So I would delete lines 1 to 24 of annoy.R -- the per-package Rd file is perfectly content to have been hand-written. Plastering over it also, among other things, destroys commit history for that file.

@AdamSpannbauer
Copy link
Contributor Author

@AdamSpannbauer AdamSpannbauer commented May 7, 2019

Seems reasonable to me. I deleted the roxygen2 style RcppAnnoy-package docs and removed the alias lines for the AnnoyIndex items that were in RcppAnnoy-package.Rd.

@eddelbuettel
Copy link
Owner

@eddelbuettel eddelbuettel commented May 10, 2019

Sorry for the delay, I am usually quicker. I am also working on some updates to testing as a first test of the new tinytest by @markvanderloo and both of those changes should go out relatively "soon".

@eddelbuettel eddelbuettel merged commit 6f35261 into eddelbuettel:master May 10, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
eddelbuettel added a commit that referenced this pull request May 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.