Skip to content

Commit

Permalink
docs: add note
Browse files Browse the repository at this point in the history
  • Loading branch information
c4710n committed Aug 24, 2024
1 parent f106c74 commit 9ac7131
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions lib/cozy_size.ex
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ defmodule CozySize do
@moduledoc """
Provides utilities for sizes.
Currently, there're three existing standards for prefixing
units of sizes:
Currently, there're three existing standards for prefixing units of sizes:
* SI
* IEC
Expand Down Expand Up @@ -31,8 +30,14 @@ defmodule CozySize do
iex> CozySize.SI.from_bytes(bytes)
{1.07, :GB}
If you want to operate on bits, please check the `*_bits` functions in each module,
which will not be further elaborated here.
If you want to operate on bits, please check the `*_bits` functions in each
module, which will not be further elaborated here.
## Note
I know there are many repetitive parts in the code, but I don't plan to
abstract them. The abstracted code might not be as easy to understand,
so I intend to leave them as they are.
"""

Expand Down

0 comments on commit 9ac7131

Please sign in to comment.