diff options
| author | Soreine <nicolas@gitbook.com> | 2016-10-19 00:34:57 +0200 |
|---|---|---|
| committer | Soreine <nicolas@gitbook.com> | 2016-10-19 00:34:57 +0200 |
| commit | 92678bb93f1e82b231282bfb98723d1eaa1b9319 (patch) | |
| tree | bed968a2a0773e066cd092d1e01872bdc7b886bc /packages/gitbook-core | |
| parent | 4f2c729d607c8d8cae73ecd106fdb2de7797ba70 (diff) | |
| download | gitbook-92678bb93f1e82b231282bfb98723d1eaa1b9319.zip gitbook-92678bb93f1e82b231282bfb98723d1eaa1b9319.tar.gz gitbook-92678bb93f1e82b231282bfb98723d1eaa1b9319.tar.bz2 | |
Clearer doc for File
Diffstat (limited to 'packages/gitbook-core')
| -rw-r--r-- | packages/gitbook-core/src/models/File.js | 5 |
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( |