Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ require 'facets'
#=> 2.0
```

`require 'facets'` loads the broadly useful **core** extensions. Some specialized core extensions are opt-in; require their method file directly. To load Facets extensions to a Ruby standard library, require that library through Facets:
`require 'facets'` loads the broadly useful **core** extensions: roughly 860 methods from 448 files, adding about 35 ms of load time and 2 MB of memory (Ruby 3.3, Linux). Some specialized core extensions are opt-in; require their method file directly. To load Facets extensions to a Ruby standard library, require that library through Facets:

```ruby
require 'facets/ostruct'
Expand Down
2 changes: 1 addition & 1 deletion docs/_src/learn.erb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ require 'facets/array/to_ranges'
require 'facets/string'

<span class="code-comment"># Most core extensions</span>
require 'facets'</code></pre></div><p>Standard library extensions are separate from the core collection. Require each one explicitly. For example, <code>require 'facets/ostruct'</code> loads Ruby's <code>ostruct</code> and the Facets additions for it.</p><div class="callout"><strong>Using Ruby 3.5+?</strong> Add the <code>ostruct</code> gem separately if you use Facets' OpenStruct extensions. Ruby no longer includes it as a default gem.</div></section>
require 'facets'</code></pre></div><p>The core collection is light. <code>require 'facets'</code> adds about 35&nbsp;ms of load time and 2&nbsp;MB of memory, loading roughly 860 methods from 448 small files. That covers the core library only; standard library extensions load only when you require them. (Measured with Ruby 3.3 on Linux; your numbers will vary.)</p><p>Standard library extensions are separate from the core collection. Require each one explicitly. For example, <code>require 'facets/ostruct'</code> loads Ruby's <code>ostruct</code> and the Facets additions for it.</p><div class="callout"><strong>Using Ruby 3.5+?</strong> Add the <code>ostruct</code> gem separately if you use Facets' OpenStruct extensions. Ruby no longer includes it as a default gem.</div></section>
<section id="examples" class="guide-block"><p class="kicker">03 / SEE IT WORK</p><h2>A few useful facets</h2><p>These examples use methods present in the 3.2 release.</p><div class="snippet"><div class="snippet-label">RUBY</div><pre><code>require 'facets/array/to_ranges'
[1, 2, 3, 6, 7].to_ranges
<span class="code-comment">#=&gt; [1..3, 6..7]</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/learn.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
require 'facets/string'

<span class="code-comment"># Most core extensions</span>
require 'facets'</code></pre></div><p>Standard library extensions are separate from the core collection. Require each one explicitly. For example, <code>require 'facets/ostruct'</code> loads Ruby's <code>ostruct</code> and the Facets additions for it.</p><div class="callout"><strong>Using Ruby 3.5+?</strong> Add the <code>ostruct</code> gem separately if you use Facets' OpenStruct extensions. Ruby no longer includes it as a default gem.</div></section>
require 'facets'</code></pre></div><p>The core collection is light. <code>require 'facets'</code> adds about 35&nbsp;ms of load time and 2&nbsp;MB of memory, loading roughly 860 methods from 448 small files. That covers the core library only; standard library extensions load only when you require them. (Measured with Ruby 3.3 on Linux; your numbers will vary.)</p><p>Standard library extensions are separate from the core collection. Require each one explicitly. For example, <code>require 'facets/ostruct'</code> loads Ruby's <code>ostruct</code> and the Facets additions for it.</p><div class="callout"><strong>Using Ruby 3.5+?</strong> Add the <code>ostruct</code> gem separately if you use Facets' OpenStruct extensions. Ruby no longer includes it as a default gem.</div></section>
<section id="examples" class="guide-block"><p class="kicker">03 / SEE IT WORK</p><h2>A few useful facets</h2><p>These examples use methods present in the 3.2 release.</p><div class="snippet"><div class="snippet-label">RUBY</div><pre><code>require 'facets/array/to_ranges'
[1, 2, 3, 6, 7].to_ranges
<span class="code-comment">#=&gt; [1..3, 6..7]</span>
Expand Down
Loading