Repository navigation
Docs: call the software "Hot Cell" and drop the pre-release warning - #105
Merged
Merged
Conversation
The docs used "HotCell", "hotcell" and "Hot Cell" for the software, and the README still said it was pre-release after v1.0.0. Write "Hot Cell" in prose, keep `HotCell` for the namespace and `hotcell` for directories, files, gems and commands, and remove the warning. ref: #86
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
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.
Motivation
A reader of the docs pointed out that the docs mix "HotCell", "hotcell" and "Hot Cell" for the software's name, and that the README's pre-release warning has been out of date since v1.0.0.
Details
Prose, gemspec summaries and descriptions, and code comments now say "Hot Cell".
HotCellstays for the Ruby namespace, andhotcellfor directories, files, gem names and commands. Where "the hotcell gems" meant thehotcell-*gems as opposed to the Active Storage gems, the text now sayshotcell-*.The "This is pre-release software" paragraph is removed from the README's Status section.
Additional information
Runtime output is unchanged: the
hotcell NAME:prefix on boot warnings, theHotCell (12ms)log line, and thebin/conformanceresult lines. Applications and scripts may match on that output, so changing it is a separate decision.