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

Tests docs #118

Merged
merged 5 commits into from
Apr 8, 2021
Merged

Tests docs #118

merged 5 commits into from
Apr 8, 2021

Conversation

FelixErnst
Copy link
Contributor

Hi @eddelbuettel

I had a look at the code changes for the new location type. Looks all fine to me and I could quite easily expand the test to explicitly test with the new location option. (I think you made the necessary changes for the test already a few weeks ago)

One thing I would like to discuss is the name of the option dratBranch. I think this is not the correct name anymore and dratLocation would be better suited. However, I am not sure how the renaming process would affect users.

Felix

Version: 0.1.8.1
Date: 2021-03-13
Version: 0.1.8.2
Date: 2021-04-08
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I generally prefer to do this myself to mark releases, but I appreciate that you are also trying to set the release apart.)

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(It also prevents me from merging now as I have about the same at home :) Quick stash will help)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for that. 😭

Some people like the bump, some people don't. Next time I ask.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am ambivalent. I like the attention to detail, and you made enough changes to mark a delta -- just how I think. The 'cannot merge' is just a stash away so no beans. The one thing I really dislike is using .9000 :) as there is zero sense in more than one new digit, incremented starting from zero. And while I said so for years it won't change you-know-where...

It is a bit more important in larger project / possibly use of more PRs like, say, Rcpp. This was fine. Thanks again.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And the one missing piece (a ChangeLog entry) I now added.

Copy link
Contributor Author

@FelixErnst FelixErnst Apr 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I know. Justification is also a part of it, e.g. Why start at .9000 and not .0000? And why the long number anyway? I feel it some weird calcification from a long lost regex pattern.

@@ -21,4 +21,4 @@ License: GPL (>= 2)
URL: https://github.com/eddelbuettel/drat, https://dirk.eddelbuettel.com/code/drat.html
BugReports: https://github.com/eddelbuettel/drat/issues
Encoding: UTF-8
RoxygenNote: 6.0.1
RoxygenNote: 7.1.1
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I use an older/simpler roxygen by default hence the old version)

(As we can see below, a good part of the diff of Rd files is entirely spurious and just line breaks and style of function signature printing)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was one warning for me, where the location argument was in the function, but not in the docs.

See line 26 of man/pruneRepo.rd

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh. Good catch. I may have to (eventually) revert all this back just because the older / faster roxygen is my default here at home. (The new one needlessly recompiles shared libraries in packages with code which I find annoying but my issue tickets on it were all closed by the powers-that-be. Oh well. And, being an ESS user and its indentation, I am not a fan of the new look and "styling". Ah well squared. I'll hide under my rock now.)

}
runTest(wd, "docs")
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The refactoring is nice!

@eddelbuettel
Copy link
Owner

I use(d) dratBranch because it already existed. We already have three or so options, and I think on the margin I should not add to them.

I hope we can roll this out, get some experience with it and then (in due time) a) default to docs/ and b) demote or deprecate gh-pages.

@eddelbuettel eddelbuettel merged commit 7be370d into eddelbuettel:master Apr 8, 2021
eddelbuettel added a commit that referenced this pull request Apr 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants