Skip to content

Fix Colorize.enabled?'s documentation #14258

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.

Sign up for GitHub

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

Merged
straight-shoota merged 1 commit into from
Jan 29, 2024
Merged

Fix Colorize.enabled?'s documentation #14258

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/colorize.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,7 @@ module Colorize
# "hello".colorize.red.to_s # => "hello"
# ```
#
# NOTE: This is by default disabled on non-TTY devices because they likely don't support ANSI escape codes.
# This will also be disabled if the environment variable `TERM` is "dumb" or `NO_COLOR` contains any value.
# NOTE: This is by default disabled if the environment variable `NO_COLOR` contains any value.
class_property? enabled : Bool { !ENV.has_key?("NO_COLOR") }

# Makes `Colorize.enabled` `true` if and only if both of `STDOUT.tty?`
Expand Down