(copy editors) RFR 8179858: jshell tool: sync nomenclature from reference to online /help
Dan Smith
daniel.smith at oracle.com
Mon Dec 4 20:11:00 UTC 2017
Didn't find any serious problems, but here's a list of minor tweaks.
—Dan
-----
--class-path, --module-path: I don't understand the purpose of the '*' at the end, but I assume it's intentional.
"load-file": I'd tend to avoid hyphens in compound nouns and stick to "load file", but apparently conventions vary:
https://en.oxforddictionaries.com/punctuation/hyphen
"command-line": Same
"For Linux and macOS": are there other supported Unix OSes? For comparison, here's the Javadoc for System.lineSeparator: "On UNIX systems, it returns "\n"; on Microsoft Windows systems it returns "\r\n".
"A path is the directories and archives to search" --> "A path **lists** the directories and archives to search"
"module-private package": I don't know my Jigsaw terminology very well, but this may not be a standard term. javac -X says "Specify a package to be considered as exported from its defining module"
"Show the snippets, prefaced with the snippet ID": either "each snippet" or "their snippet IDs"
/save: inconsistent use of periods (this comment may apply more broadly—should do a quick pass to check)
/types: An enum is a kind of class, so it's not necessary to list it separately (and it makes me think "what about annotation types?"). Just "classes and interfaces" is fine. I'd also replace "types" with "type declarations" throughout, because "type" is such an overloaded term.
"since jshell was entered, or a /reset, or /reload command was executed" --> "since jshell was entered, or a /reset or /reload command was executed"
"Errors will display" --> "Errors will be displayed"
"the snippets will be replayed -- the replay is not shown, however, errors will display" --> "the snippits will be replayed. The replay is not shown, **but any** errors will *be displayed*."
ID ranges: these are listed everywhere as a distinct variant, but help.id suggests that they can appear within a list, interleaved with non-ranges. Which is it? (If the latter, maybe don't mention ranges at all for /vars, etc., and explain elsewhere that an "ID" may be a range of simple IDs. Or, if that's too obscure, try "specified snippet ID or range of snippet IDs" in /vars, etc. Or just give the list variant in /var, etc., more details about ranges.)
"when the jshell is started" "when jshell is restarted" "since this jshell was launched" "debugging of the jshell" "information about jshell": Need to decide is "jshell" refers to the command, or if it's another word for "shell"
"These options configure the evaluation context, they can be specified" --> "These options configure the evaluation context. They can be specified"
"A list of directories, each directory is a directory of modules." --> "A list of directories, **where** each directory **contains** modules"
"quoted strings printed as input prompts; Both" -- make that a period
More information about the kulla-dev
mailing list