summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-core/src/models/File.js
diff options
context:
space:
mode:
Diffstat (limited to 'packages/gitbook-core/src/models/File.js')
-rw-r--r--packages/gitbook-core/src/models/File.js5
1 files changed, 2 insertions, 3 deletions
diff --git a/packages/gitbook-core/src/models/File.js b/packages/gitbook-core/src/models/File.js
index c5ac654..efc4f11 100644
--- a/packages/gitbook-core/src/models/File.js
+++ b/packages/gitbook-core/src/models/File.js
@@ -21,9 +21,8 @@ class File extends Record(DEFAULTS) {
}
/**
- * Returns the relative path from this file to "to"
- * @param {String} to
- * @return {String}
+ * @param {String} to Absolute path
+ * @return {String} The same path, but relative to this file
*/
relative(to) {
return path.relative(