Added note about imports where necessary

src/benchmark.cr

@@ -3,6 +3,8 @@ require "./benchmark/**"
 # The Benchmark module provides methods for benchmarking Crystal code, giving
 # detailed reports on the time and memory taken for each task.
 #
+# NOTE: To use `Benchmark`, you must explicitly import it with `require "benchmark"` 
+#
 # ### Measure the number of iterations per second of each task
 #
 # ```

src/big/big_decimal.cr

@@ -12,6 +12,8 @@ end
 # Value contains the actual value, and scale tells the decimal point place.
 # E.g. when value is `1234` and scale `2`, the result is `12.34`.
 #
+# NOTE: To use `BigDecimal`, you must explicitly import it with `require "big"`
+#
 # The general idea and some of the arithmetic algorithms were adapted from
 # the MIT/APACHE-licensed [bigdecimal-rs](https://github.com/akubera/bigdecimal-rs).
 struct BigDecimal < Number

src/big/big_float.cr

@@ -4,6 +4,8 @@ require "big"
 # A `BigFloat` can represent arbitrarily large floats.
 #
 # It is implemented under the hood with [GMP](https://gmplib.org/).
+#
+# NOTE: To use `BigFloat`, you must explicitly import it with `require "big"`
 struct BigFloat < Float
   include Comparable(Int)
   include Comparable(BigFloat)

src/big/big_int.cr

@@ -5,6 +5,8 @@ require "random"
 # A `BigInt` can represent arbitrarily large integers.
 #
 # It is implemented under the hood with [GMP](https://gmplib.org/).
+#
+# NOTE: To use `BigInt`, you must explicitly import it with `require "big"`
 struct BigInt < Int
   include Comparable(Int::Signed)
   include Comparable(Int::Unsigned)

src/big/big_rational.cr

@@ -5,6 +5,8 @@ require "big"
 # denominator and the numerator have no common factors, and that the
 # denominator is positive. Zero has the unique representation 0/1.
 #
+# NOTE: To use `BigRational`, you must explicitly import it with `require "big"`
+#
 # ```
 # require "big"
 #

src/bit_array.cr

@@ -4,6 +4,8 @@
 # `UInt32`s. The total number of bits stored is set at creation and is
 # immutable.
 #
+# NOTE: To use `BitArray`, you must explicitly import it with `require "bit_array"`
+#
 # ### Example
 #
 # ```

src/colorize.cr

@@ -3,6 +3,8 @@
 # as its main interface, which calls `to_s` and surrounds it with the necessary escape codes
 # when it comes to obtaining a string representation of the object.
 #
+# NOTE: To use `Colorize`, you must explicitly import it with `require "colorize"`
+#
 # Its first argument changes the foreground color:
 #
 # ```

src/complex.cr

@@ -3,6 +3,8 @@
 # The a is the real part of the number, and the b is the imaginary part of
 # the number.
 #
+# NOTE: To use `Complex`, you must explicitly import it with `require "complex"`
+#
 # ```
 # require "complex"
 #

src/compress/deflate/deflate.cr

@@ -6,6 +6,8 @@ require "./*"
 #
 # See `Gzip`, `Zip` and `Zlib` for modules that provide access
 # to DEFLATE-based file formats.
+#
+# NOTE: To use `Deflate` or its children, you must explicitly import it with `require "compress/deflate"`
 module Compress::Deflate
   NO_COMPRESSION      =  0
   BEST_SPEED          =  1

src/compress/gzip/gzip.cr

@@ -3,6 +3,8 @@ require "digest/crc32"
 
 # The Gzip module contains readers and writers of gzip format compressed
 # data, as specified in [RFC 1952](https://www.ietf.org/rfc/rfc1952.txt).
+#
+# NOTE: To use `Gzip` or its children, you must explicitly import it with `require "compress/gzip"`
 module Compress::Gzip
   NO_COMPRESSION      = Compress::Deflate::NO_COMPRESSION
   BEST_SPEED          = Compress::Deflate::BEST_SPEED

src/compress/zip/zip.cr

@@ -4,6 +4,8 @@ require "digest/crc32"
 # The Compress::Zip module contains readers and writers of the zip
 # file format, described at [PKWARE's site](https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.3.TXT).
 #
+# NOTE: To use `Zip` or its children, you must explicitly import it with `require "compress/zip"`
+#
 # ### Reading zip files
 #
 # Two types are provided to read from zip files:

src/compress/zlib/zlib.cr

@@ -3,6 +3,8 @@ require "digest/adler32"
 
 # The Compress::Zlib module contains readers and writers of zlib format compressed
 # data, as specified in [RFC 1950](https://www.ietf.org/rfc/rfc1950.txt).
+#
+# NOTE: To use `Zlib` or its children, you must explicitly import it with `require "compress/zlib"`
 module Compress::Zlib
   NO_COMPRESSION      = Compress::Deflate::NO_COMPRESSION
   BEST_SPEED          = Compress::Deflate::BEST_SPEED

src/crypto/bcrypt.cr

@@ -29,6 +29,8 @@ require "./subtle"
 # Last but not least: beware of denial of services! Always protect your
 # application using an external strategy (eg: rate limiting), otherwise
 # endpoints that verifies bcrypt hashes will be an easy target.
+#
+# NOTE: To use `Bcrypt`, you must explicitly import it with `require "crypto/bcrypt"`
 class Crypto::Bcrypt
   class Error < Exception
   end

src/crypto/bcrypt/password.cr

@@ -3,6 +3,8 @@ require "../subtle"
 
 # Generate, read and verify `Crypto::Bcrypt` hashes.
 #
+# NOTE: To use `Password`, you must explicitly import it with `require "crypto/bcrypt/password"`
+#
 # ```
 # require "crypto/bcrypt/password"
 #

src/csv.cr

@@ -3,6 +3,8 @@
 #
 # This module conforms to [RFC 4180](https://tools.ietf.org/html/rfc4180).
 #
+# NOTE: To use `CSV` or its children, you must explicitly import it with `require "csv"`
+#
 # ### Parsing
 #
 # Several ways of parsing CSV are provided. The most straight-forward, but

src/digest/adler32.cr

@@ -2,6 +2,8 @@ require "lib_z"
 require "./digest"
 
 # Implements the Adler32 checksum algorithm.
+#
+# NOTE: To use `Adler32`, you must explicitly import it with `require "digest/adler32"`
 class Digest::Adler32 < ::Digest
   extend ClassMethods
 

src/digest/crc32.cr

@@ -2,6 +2,8 @@ require "lib_z"
 require "./digest"
 
 # Implements the CRC32 checksum algorithm.
+#
+# NOTE: To use `CRC32`, you must explicitly import it with `require "digest/crc32"`
 class Digest::CRC32 < ::Digest
   extend ClassMethods
 

src/digest/md5.cr

@@ -3,6 +3,8 @@ require "openssl"
 
 # Implements the MD5 digest algorithm.
 #
+# NOTE: To use `MD5`, you must explicitly import it with `require "digest/md5"`
+#
 # WARNING: MD5 is no longer a cryptographically secure hash, and should not be
 # used in security-related components, like password hashing. For passwords, see
 # `Crypto::Bcrypt::Password`. For a generic cryptographic hash, use SHA-256 via

src/digest/sha1.cr

@@ -3,6 +3,8 @@ require "openssl"
 
 # Implements the SHA1 digest algorithm.
 #
+# NOTE: To use `SHA1`, you must explicitly import it with `require "digest/sha1"`
+#
 # WARNING: SHA1 is no longer a cryptographically secure hash, and should not be
 # used in security-related components, like password hashing. For passwords, see
 # `Crypto::Bcrypt::Password`. For a generic cryptographic hash, use SHA-256 via

src/digest/sha256.cr

@@ -2,6 +2,8 @@ require "./digest"
 require "openssl"
 
 # Implements the SHA256 digest algorithm.
+#
+# NOTE: To use `SHA256`, you must explicitly import it with `require "digest/sha256"`
 class Digest::SHA256 < ::OpenSSL::Digest
   extend ClassMethods
 

src/digest/sha512.cr

@@ -2,6 +2,8 @@ require "./digest"
 require "openssl"
 
 # Implements the SHA512 digest algorithm.
+#
+# NOTE: To use `SHA256`, you must explicitly import it with `require "digest/sha512"`
 class Digest::SHA512 < ::OpenSSL::Digest
   extend ClassMethods
 

src/ecr.cr

@@ -16,6 +16,8 @@
 # tag: `<%# hello %>`. An ECR tag can be inserted directly (i.e. the tag itself may be
 # escaped) by using a second `%` like so: `<%% a = b %>` or `<%%= foo %>`.
 #
+# NOTE: To use `ECR`, you must explicitly import it with `require "ecr"`
+#
 # Quick Example:
 #
 # Create a simple ECR file named `greeter.ecr`:

src/file_utils.cr

@@ -1,3 +1,4 @@
+# NOTE: To use `FileUtils`, you must explicitly import it with `require "file_utils"`
 module FileUtils
   extend self
 

src/html.cr

@@ -3,6 +3,8 @@ require "./html/entities"
 # Provides HTML escaping and unescaping methods.
 #
 # For HTML *parsing* see module XML, especially `XML.parse_html`.
+#
+# NOTE: To use `HTML`, you must explicitly import it with `require "html"`
 module HTML
   private SUBSTITUTIONS = {
     '&'  => "&",

src/http.cr

@@ -5,5 +5,7 @@ require "./http/log"
 require "./http/common"
 
 # The HTTP module contains `HTTP::Client`, `HTTP::Server` and `HTTP::WebSocket` implementations.
+#
+# NOTE: To use `HTTP`, you must explicitly import it with `require "http"`
 module HTTP
 end

src/http/client.cr

@@ -4,6 +4,8 @@
 
 # An HTTP Client.
 #
+# NOTE: To use `Client`, you must explicitly import it with `require "http/client"`
+#
 # ### One-shot usage
 #
 # Without a block, an `HTTP::Client::Response` is returned and the response's body

src/http/cookie.cr

@@ -2,6 +2,8 @@ require "./common"
 
 module HTTP
   # Represents a cookie with all its attributes. Provides convenient access and modification of them.
+  #
+  # NOTE: To use `Cookie`, you must explicitly import it with `require "http/cookie"`
   class Cookie
     # Possible values for the `SameSite` cookie as described in the [Same-site Cookies Draft](https://tools.ietf.org/html/draft-west-first-party-cookies-07#section-4.1.1).
     enum SameSite
@@ -273,6 +275,8 @@ module HTTP
 
   # Represents a collection of cookies as it can be present inside
   # a HTTP request or response.
+  #
+  # NOTE: To use `Cookies`, you must explicitly import it with `require "http/cookie"`
   class Cookies
     include Enumerable(Cookie)
 

src/http/formdata.cr

@@ -4,6 +4,8 @@ require "mime/multipart"
 # Contains utilities for parsing `multipart/form-data` messages, which are
 # commonly used for encoding HTML form data.
 #
+# NOTE: To use `FormData`, you must explicitly import it with `require "http"`
+#
 # ### Examples
 #
 # Commonly, you'll want to parse a from response from a HTTP request, and

src/http/headers.cr

@@ -2,6 +2,8 @@
 #
 # Two headers are considered the same if their downcase representation is the same
 # (in which `_` is the downcase version of `-`).
+#
+# NOTE: To use `Headers`, you must explicitly import it with `require "http/headers"`
 struct HTTP::Headers
   include Enumerable({String, Array(String)})
 

src/http/request.cr

@@ -12,6 +12,8 @@ require "socket"
 # When creating a request with a `String` or `Bytes` its body
 # will be a `IO::Memory` wrapping these, and the `Content-Length`
 # header will be set appropriately.
+#
+# NOTE: To use `Request`, you must explicitly import it with `require "http/request"`
 class HTTP::Request
   property method : String
   property headers : Headers

src/http/server.cr

@@ -15,6 +15,8 @@ require "log"
 # A server is initialized with a handler chain responsible for processing each
 # incoming request.
 #
+# NOTE: To use `Server`, you must explicitly import it with `require "http/server"`
+#
 # ```
 # require "http/server"
 #

src/http/server/handler.cr

@@ -4,6 +4,8 @@ require "./context"
 # You can use a handler to intercept any incoming request and can modify the response.
 # These can be used for request throttling, ip-based filtering, adding custom headers e.g.
 #
+# NOTE: To use `Handler`, you must explicitly import it with `require "http/server/handler"`
+#
 # ### A custom handler
 #
 # ```

src/http/server/handlers/compress_handler.cr

@@ -5,6 +5,8 @@
 
 # A handler that configures an `HTTP::Server::Response` to compress the response
 # output, either using gzip or deflate, depending on the `Accept-Encoding` request header.
+#
+# NOTE: To use `CompressHandler`, you must explicitly import it with `require "http"`
 class HTTP::CompressHandler
   include HTTP::Handler
 

src/http/server/handlers/error_handler.cr

@@ -6,6 +6,8 @@
 #
 # This handler also logs the exceptions to the specified logger or
 # the logger for the source "http.server" by default.
+#
+# NOTE: To use `ErrorHandler`, you must explicitly import it with `require "http"`
 class HTTP::ErrorHandler
   include HTTP::Handler
 

src/http/server/handlers/log_handler.cr

@@ -2,6 +2,8 @@ require "log"
 
 # A handler that logs the request method, resource, status code, and
 # the time used to execute the next handler
+#
+# NOTE: To use `LogHandler`, you must explicitly import it with `require "http"`
 class HTTP::LogHandler
   include HTTP::Handler
 

src/http/server/handlers/static_file_handler.cr

@@ -8,6 +8,8 @@ require "mime"
 # This handler can send precompressed content, if the client accepts it, and a file
 # with the same name and `.gz` extension appended is found in the same directory.
 # Precompressed files are only served if they are newer than the original file.
+#
+# NOTE: To use `StaticFileHandler`, you must explicitly import it with `require "http"`
 class HTTP::StaticFileHandler
   include HTTP::Handler
 

src/http/server/handlers/websocket_handler.cr

@@ -3,6 +3,8 @@ require "http/web_socket"
 
 # A handler which adds websocket functionality to an `HTTP::Server`.
 #
+# NOTE: To use `WebSocketHandler`, you must explicitly import it with `require "http"`
+#
 # When a request can be upgraded, the associated `HTTP::Websocket` and
 # `HTTP::Server::Context` will be yielded to the block. For example:
 #

src/http/status.cr

@@ -4,6 +4,8 @@
 #
 # It provides constants for the defined HTTP status codes as well as helper
 # methods to easily identify the type of response.
+#
+# NOTE: To use `Status`, you must explicitly import it with `require "http/status"`
 enum HTTP::Status
   CONTINUE                        = 100
   SWITCHING_PROTOCOLS             = 101

src/http/web_socket.cr

@@ -1,6 +1,8 @@
 require "./client"
 require "./headers"
 
+
+# NOTE: To use `WebSocket`, you must explicitly import it with `require "http/web_socket"`
 class HTTP::WebSocket
   getter? closed = false
 

src/ini.cr

@@ -1,3 +1,4 @@
+# NOTE: To use `INI`, you must explicitly import it with `require "ini"`
 module INI
   # Exception thrown on an INI parse error.
   class ParseException < Exception

src/json.cr

@@ -1,5 +1,7 @@
 # The JSON module allows parsing and generating [JSON](http://json.org/) documents.
 #
+# NOTE: To use `JSON` or its children, you must explicitly import it with `require "json"`
+#
 # ### General type-safe interface
 #
 # The general type-safe interface for parsing JSON is to invoke `T.from_json` on a

src/levenshtein.cr

@@ -1,4 +1,6 @@
 # Levenshtein distance methods.
+#
+# NOTE: To use `Levenshtein`, you must explicitly import it with `require "levenshtein"`
 module Levenshtein
   # Computes the [levenshtein distance](http://en.wikipedia.org/wiki/Levenshtein_distance) of two strings.
   #

src/log.cr

@@ -7,6 +7,8 @@
 # `#error`, and `#fatal` methods. They expect a block that will evaluate to the
 # message of the entry:
 #
+# NOTE: To use `Log`, you must explicitly import it with `require "log"`
+#
 # ```
 # require "log"
 #

src/mime.cr

@@ -2,6 +2,8 @@ require "crystal/system/mime"
 
 # This module implements a global MIME registry.
 #
+# NOTE: To use `MIME`, you must explicitly import it with `require "mime"`
+#
 # ```
 # require "mime"
 #