-
Notifications
You must be signed in to change notification settings - Fork 73
R 1.0.0 #296
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
R 1.0.0 #296
Conversation
Codecov Report
@@ Coverage Diff @@
## master #296 +/- ##
=======================================
Coverage 91.47% 91.47%
=======================================
Files 30 30
Lines 1326 1326
=======================================
Hits 1213 1213
Misses 113 113
Continue to review full report at Codecov.
|
186e05a
to
c23e8e5
Compare
31b803b
to
7c1a50d
Compare
This is the result from
https://win-builder.r-project.org/0uoMp9FDVJVz/00check.log All the other things from #145 are incorporated, so I think we are ready for the submission. Do we need to state this other note separately, i.e. per built environment? Also why is there no note about the fact that this is a new release? |
Also, @krlmlr can you update the pkgdown page before the submission? |
For |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few more minor nits, we might need to review initialize_attributes
.
DESCRIPTION
Outdated
@@ -1,6 +1,6 @@ | |||
Package: styler | |||
Title: Non-invasive Pretty Printing of R code | |||
Version: 0.0-11 | |||
Title: Non-Invasive Pretty Printing of R code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
winbuilder complains that "code" needs to be capitalized too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right...
NEWS.md
Outdated
- Create and serialize nested parse data. | ||
- Internal support for indention of expressions with parentheses. | ||
- Adding and removing spaces around operators on flat parse data. | ||
## styler 0.1.0 (2017-12-05) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1.0.0 now, I forgot to update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure.
NEWS.md
Outdated
style_text(text, ..., style = tidyverse_style, transformers = style(...)) | ||
``` | ||
|
||
### style guide creators |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think for a user the tidyverse_style()
function is more important than create_style_guide()
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, moved them up.
NEWS.md
Outdated
This function is used to create a style guide. | ||
``` | ||
create_style_guide( | ||
initialize = initialize_attributes, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is initialize_attributes
? It should be either exported (and then perhaps be a function like default_style_guide_attributes()
), or initialize
should accept a default argument of NULL
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, thanks, forgot about that. I think we may rename it to default_style_guide_attributes()
then and export it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need an update?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes -.-
NEWS.md
Outdated
|
||
These are helper functions that simply forward to the helper functions above. | ||
``` | ||
tidyverse_reindention() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add these two to the "style guides" section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok.
Yes, we can remove old news. Added deploy key and restarted Travis job https://travis-ci.org/r-lib/styler/jobs/311941953, which should update pkgdown. |
Restarted job https://travis-ci.org/r-lib/styler/jobs/311951016 instead, this is the correct 0.0-11 release. |
Built pkgdown manually, for some reason the rebuild on Travis CI doesn't catch all changes. |
2a4c554
to
c665894
Compare
Can't figure out why the appveyor buid fails now. Maybe currently updating to 3.4.3? |
New winbuild results
Code is now capitalised in the DESCRIPTION, so everything should be fine now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, almost ready to go! I think we can ignore AppVeyor failures for now, krlmlr/r-appveyor#99.
NEWS.md
Outdated
This function is used to create a style guide. | ||
``` | ||
create_style_guide( | ||
initialize = initialize_attributes, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need an update?
I also rephrased the help file for |
Are we set for the release? |
Should we also style the source code with styler prior to the CRAN submission? |
c62de00
to
e133152
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think so.
This function is used to create a style guide. | ||
``` | ||
create_style_guide( | ||
initialize = default_style_guide_attributes, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need parens here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No there must not be braces, see the example in the docs
set_line_break_before_curly_opening <- function(pd_flat) {
op <- pd_flat$token %in% "'{'"
pd_flat$lag_newlines[op] <- 1L
pd_flat
}
set_line_break_before_curly_opening_style <- function() {
create_style_guide(line_break = set_line_break_before_curly_opening)
}
style_text("a <- function(x) { ! x }", style = set_line_break_before_curly_opening_style)
I hope the following is clear enough:
#' @param line_break A list of transformer functions that manipulate line_break
#' information.
The other arguments are described in a similar fashion.
Do you think it's clear enough or should we describe each of these arguments more explicitly, i.e. like this:
#' @param line_break A list of bare transformer function names that manipulate
#' line_break information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, I see. Makes sense.
I don't mind postponing styling styler until after the CRAN release, but we can do it if you like. |
Not to be merged. Aims to close #145.