Docs: API documentation improvements based on feedback · gulpjs/gulp@0a68710

7 files changed

lines changed

Original file line numberDiff line numberDiff line change

@@ -54,7 +54,9 @@ File system modes determine what permissions exist for a file. Most files and di

5454
5555

## Modules

5656
57-

Gulp is made up of many small modules that are pulled together to work cohesively. By utilizing [semver][semver-external] within the small modules, we can release bug fixes and features without publishing new versions of gulp. If you encounter an issue related to one of these modules, open an issue on the individual project repository.

57+

Gulp is made up of many small modules that are pulled together to work cohesively. By utilizing [semver][semver-external] within the small modules, we can release bug fixes and features without publishing new versions of gulp. Often, when you don't see progress on the main repository, work is being done in one of these modules.

58+
59+

If you're having trouble, ensure your current modules are updated - using the `npm update` command. If the problem persists, open an issue on the individual project repository.

5860
5961

* [undertaker][undertaker-external] - the task registration system

6062

* [vinyl][vinyl-external] - the virtual file objects

Original file line numberDiff line numberDiff line change

@@ -7,7 +7,7 @@ sidebar_label: parallel()

77
88

# parallel()

99
10-

Combines task functions and/or composed operations into larger operations that will be executed simultaneously. The composed operations from `series()` and `parallel()` can be nested to any depth.

10+

Combines task functions and/or composed operations into larger operations that will be executed simultaneously. There are no imposed limits on the nesting depth of composed operations using `series()` and `parallel()`.

1111
1212

## Usage

1313
Original file line numberDiff line numberDiff line change

@@ -7,7 +7,7 @@ sidebar_label: series()

77
88

# series()

99
10-

Combines task functions and/or composed operations into larger operations that will be executed one after another, in sequential order. The composed operations from `series()` and `parallel()` can be nested to any depth.

10+

Combines task functions and/or composed operations into larger operations that will be executed one after another, in sequential order. There are no imposed limits on the nesting depth of composed operations using `series()` and `parallel()`.

1111
1212

## Usage

1313
Original file line numberDiff line numberDiff line change

@@ -9,7 +9,7 @@ sidebar_label: src()

99
1010

Creates a stream for reading [Vinyl][vinyl-concepts] objects from the file system.

1111
12-

**Note:** Any UTF-8 BOMs will be removed from UTF-8 files read by `src()`, unless disabled using the `removeBOM` option.

12+

**Note:** BOMs (byte order marks) have no purpose in UTF-8 and will be removed from UTF-8 files read by `src()`, unless disabled using the `removeBOM` option.

1313
1414

## Usage

1515

@@ -58,7 +58,7 @@ When an invalid glob is given in `globs`, throws an error with the message, "Inv

5858

| buffer | boolean <br> function | true | When true, file contents are buffered into memory. If false, the Vinyl object's `contents` property will be a paused stream. Contents of large files may not be able to be buffered. <br> **Note:** Plugins may not implement support for streaming contents. |

5959

| read | boolean <br> function | true | If false, files will be not be read and their Vinyl objects won't be writable to disk via `.dest()`. |

6060

| since | date <br> timestamp <br> function | | When set, only creates Vinyl objects for files that have been modified since the specified time. |

61-

| removeBOM | boolean <br> function | true | When true, removes the BOM from UTF-8 encoded files. If false, ignores a BOM.. |

61+

| removeBOM | boolean <br> function | true | When true, removes the BOM from UTF-8 encoded files. If false, ignores a BOM. |

6262

| sourcemaps | boolean <br> function | false | If true, enables [sourcemaps][sourcemaps-section] support on Vinyl objects created. Loads inline sourcemaps and resolves external sourcemap links. |

6363

| resolveSymlinks | boolean <br> function | true | When true, recursively resolves symbolic links to their targets. If false, preserves the symbolic links and sets the Vinyl object's `symlink` property to the original file's path. |

6464

| cwd | string | `process.cwd()` | The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `globs` with `path.join()`. <br> _This option is passed directly to [glob-stream][glob-stream-external]._ |

Original file line numberDiff line numberDiff line change

@@ -10,7 +10,7 @@ sidebar_label: symlink()

1010

Creates a stream for linking [Vinyl][vinyl-concepts] objects to the file system.

1111
1212

## Usage

13-

'

13+
1414

```js

1515

const { src, symlink } = require('gulp');

1616
Original file line numberDiff line numberDiff line change

@@ -7,7 +7,7 @@ sidebar_label: task()

77
88

# task()

99
10-

**Reminder**: This API isn't the recommended pattern anymore - export your tasks.

10+

**Reminder**: This API isn't the recommended pattern anymore - [export your tasks][creating-tasks-docs].

1111
1212

Defines a task within the task system. The task can then be accessed from the command line and the `series()`, `parallel()`, and `lastRun()` APIs.

1313

@@ -106,4 +106,5 @@ task(build);

106106
107107

[task-metadata-section]: #task-metadata

108108

[task-concepts]: concepts.md#tasks

109+

[creating-tasks-docs]: ../getting-started/3-creating-tasks.md

109110

[function-name-external]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/name

Original file line numberDiff line numberDiff line change

@@ -120,7 +120,7 @@ All internally managed paths - any instance property except `contents` and `stat

120120
121121

## Normalization and concatenation

122122
123-

All path properties are normalized by their setters. Concatenate paths with `/`, instead of using `path.join()`, and normalization will occur properly on all platforms. Never concatenate with `\` - it is a valid filename character on posix system.

123+

All path properties are normalized by their setters. Concatenate paths with `/`, instead of using `path.join()`, and normalization will occur properly on all platforms. Never concatenate with `\` - it is a valid filename character on POSIX system.

124124
125125

```js

126126

const file = new File();