Clean up the prose added for v1.0 - #1289
Merged
Merged
Conversation
A read of everything the v1.0 branch adds to NEWS, the roxygen and the internals vignette, done before the release candidate. Most of the changes make make and stanc bare lowercase words in prose, which the new text spelled three ways; backticks stay only for code the reader types or reads, such as `make/local` or `STANCFLAGS`. Two errors in R/cpp_options.R now quote argument names with backticks like the rest of the new errors, an error in R/build.R no longer reads "executable executable", and a handful of roxygen paragraphs and vignette sentences are shortened or split. The tests that match the changed error text are updated to the new wording. Part of #1258.
The messages written for v1.0 put argument names, methods and typed expressions in backticks, while the older messages used single quotes for the same things, so a user could meet `init` in one error and 'init' in the next. This makes backticks the rule for code the reader types: arguments, methods such as `$code()`, classes, options, expressions like `quiet = FALSE`, shell commands, and literal values as `"newton"`. Values quoted back at the user, such as paths, user header files and Stan data variable names, keep their single quotes, since they are not code. Program and package names are bare words. The tests and snapshots that match the changed text are updated. Two prose lines that still backticked stanc as a program name are fixed as well. The timeout test in test-install.R expected a message install_cmdstan() prints only when a release URL is given, and with a doubled asterisk; the branch only runs when no installation exists in the temporary directory yet, so CI never saw it. It now expects the message the default path prints. Part of #1258.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## v1.0 #1289 +/- ##
=======================================
Coverage ? 93.05%
=======================================
Files ? 19
Lines ? 7317
Branches ? 0
=======================================
Hits ? 6809
Misses ? 508
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Submission Checklist
Summary
A clean up of the prose the v1.0 branch adds (NEWS, roxygen, the internals vignette). This PR also makes the use of backticks vs quotes consistent in error messages.
Copyright and Licensing
Please list the copyright holder for the work you are submitting
(this will be you or your assignee, such as a university or company):
Jonah Gabry
By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the following licenses: