Skip to content

Commit

Permalink
Few more tiny doc fixes >_<
Browse files Browse the repository at this point in the history
  • Loading branch information
arp242 committed Oct 22, 2023
1 parent c3fa8e6 commit cfc9c4f
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 30 deletions.
10 changes: 5 additions & 5 deletions backend_fen.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,11 @@ type Watcher struct {

// Errors sends any errors.
//
// [ErrEventOverflow] is used to indicate there are too many events:
// ErrEventOverflow is used to indicate there are too many events:
//
// - inotify: there are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; [WithBufferSize] can be used to increase it.
// - kqueue, fen: not used.
// - inotify: There are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
// - kqueue, fen: Not used.
Errors chan error

mu sync.Mutex
Expand All @@ -142,7 +142,7 @@ func NewWatcher() (*Watcher, error) {
return NewBufferedWatcher(0)
}

// NewBufferedWatcher creates a new Watcher with a buffered [Watcher.Events]
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
// channel.
//
// The main use case for this is situations with a very large number of events
Expand Down
10 changes: 5 additions & 5 deletions backend_inotify.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,11 @@ type Watcher struct {

// Errors sends any errors.
//
// [ErrEventOverflow] is used to indicate there are too many events:
// ErrEventOverflow is used to indicate there are too many events:
//
// - inotify: there are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; [WithBufferSize] can be used to increase it.
// - kqueue, fen: not used.
// - inotify: There are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
// - kqueue, fen: Not used.
Errors chan error

// Store fd here as os.File.Read() will no longer return on close after
Expand Down Expand Up @@ -241,7 +241,7 @@ func NewWatcher() (*Watcher, error) {
return NewBufferedWatcher(0)
}

// NewBufferedWatcher creates a new Watcher with a buffered [Watcher.Events]
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
// channel.
//
// The main use case for this is situations with a very large number of events
Expand Down
10 changes: 5 additions & 5 deletions backend_kqueue.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,11 @@ type Watcher struct {

// Errors sends any errors.
//
// [ErrEventOverflow] is used to indicate there are too many events:
// ErrEventOverflow is used to indicate there are too many events:
//
// - inotify: there are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; [WithBufferSize] can be used to increase it.
// - kqueue, fen: not used.
// - inotify: There are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
// - kqueue, fen: Not used.
Errors chan error

done chan struct{}
Expand All @@ -153,7 +153,7 @@ func NewWatcher() (*Watcher, error) {
return NewBufferedWatcher(0)
}

// NewBufferedWatcher creates a new Watcher with a buffered [Watcher.Events]
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
// channel.
//
// The main use case for this is situations with a very large number of events
Expand Down
10 changes: 5 additions & 5 deletions backend_other.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,11 @@ type Watcher struct {

// Errors sends any errors.
//
// [ErrEventOverflow] is used to indicate there are too many events:
// ErrEventOverflow is used to indicate there are too many events:
//
// - inotify: there are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; [WithBufferSize] can be used to increase it.
// - kqueue, fen: not used.
// - inotify: There are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
// - kqueue, fen: Not used.
Errors chan error
}

Expand All @@ -128,7 +128,7 @@ func NewWatcher() (*Watcher, error) {
return nil, errors.New("fsnotify not supported on the current platform")
}

// NewBufferedWatcher creates a new Watcher with a buffered [Watcher.Events]
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
// channel.
//
// The main use case for this is situations with a very large number of events
Expand Down
10 changes: 5 additions & 5 deletions backend_windows.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,11 +131,11 @@ type Watcher struct {

// Errors sends any errors.
//
// [ErrEventOverflow] is used to indicate there are too many events:
// ErrEventOverflow is used to indicate there are too many events:
//
// - inotify: there are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; [WithBufferSize] can be used to increase it.
// - kqueue, fen: not used.
// - inotify: There are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
// - kqueue, fen: Not used.
Errors chan error

port windows.Handle // Handle to completion port
Expand All @@ -152,7 +152,7 @@ func NewWatcher() (*Watcher, error) {
return NewBufferedWatcher(50)
}

// NewBufferedWatcher creates a new Watcher with a buffered [Watcher.Events]
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
// channel.
//
// The main use case for this is situations with a very large number of events
Expand Down
10 changes: 5 additions & 5 deletions mkdoc.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ EOF
)

newbuffered=$(<<EOF
// NewBufferedWatcher creates a new Watcher with a buffered [Watcher.Events]
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
// channel.
//
// The main use case for this is situations with a very large number of events
Expand Down Expand Up @@ -211,11 +211,11 @@ EOF
errors=$(<<EOF
// Errors sends any errors.
//
// [ErrEventOverflow] is used to indicate there are too many events:
// ErrEventOverflow is used to indicate there are too many events:
//
// - inotify: there are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; [WithBufferSize] can be used to increase it.
// - kqueue, fen: not used.
// - inotify: There are too many queued events (fs.inotify.max_queued_events sysctl)
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
// - kqueue, fen: Not used.
EOF
)

Expand Down

0 comments on commit cfc9c4f

Please sign in to comment.