We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 57aa996 commit 2a59ddbCopy full SHA for 2a59ddb
lib/faster_path.rb
@@ -6,8 +6,13 @@
6
require 'fiddle/import'
7
8
# FasterPath module behaves as a singleton object with the alternative method
9
-# implementations for Pathname, and some for File, available directly on it.
+# implementations for `Pathname`, and some for `File`, available directly on it.
10
#
11
+# New projects are recommend to reference methods defined directly on `FasterPath`.
12
+# Existing websites may use the `FasterPath.sledgehammer_everything!` method to
13
+# directly injet the more performant implementations of path handling in to their
14
+# existing code ecosystem. To do so you will need to
15
+# `require 'faster_path/optional/monkeypatches'` beforehand.
16
module FasterPath
17
FFI_LIBRARY = begin
18
toplevel_dir = File.dirname(__dir__)
0 commit comments