Documentation update

Stop / Continue naming change

doc/all.md

@@ -42,8 +42,8 @@ true
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/average.md

@@ -48,8 +48,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/contains.md

@@ -32,11 +32,11 @@ true
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)
 
 ### WithObservationStrategy
 

doc/debounce.md

@@ -34,8 +34,8 @@ Output: each item emitted by the Observable if not item has been emitted after 2
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/distinct.md

@@ -45,8 +45,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/filter.md

@@ -42,8 +42,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/flatmap.md

@@ -48,8 +48,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/map.md

@@ -1,3 +1,4 @@
+
 # Map Operator
 
 ## Overview
@@ -43,8 +44,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/marshal.md

@@ -48,8 +48,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/max.md

@@ -41,8 +41,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/min.md

@@ -41,8 +41,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/options.md

@@ -35,13 +35,13 @@ rxgo.WithObservation(rxgo.Eager)
 * Stop (default): stop processing if the Observable produces an error.
 
 ```go
-rxgo.WithErrorStrategy(rxgo.Stop)
+rxgo.WithErrorStrategy(rxgo.StopOnError)
 ```
 
 * Continue: continue processing items if the Observable produces an error.
 
 ```go
-rxgo.WithErrorStrategy(rxgo.Continue)
+rxgo.WithErrorStrategy(rxgo.ContinueOnError)
 ```
 
 This strategy is propagated to the parent(s) Observable(s).

doc/reduce.md

@@ -44,8 +44,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/serialize.md

@@ -45,8 +45,8 @@ true
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/sum.md

@@ -44,8 +44,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

doc/unmarshal.md

@@ -47,8 +47,8 @@ Output:
 
 ### WithPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withpool
+[Detail](options.md#withpool)
 
 ### WithCPUPool
 
-https://github.com/ReactiveX/RxGo/wiki/Options#withcpupool
+[Detail](options.md#withcpupool)

duration.go

@@ -87,9 +87,8 @@ func (d *causalityDuration) duration() time.Duration {
 	d.fs = d.fs[1:]
 	if pop.isTick {
 		return time.Nanosecond
-	} else {
-		return time.Minute
 	}
+	return time.Minute
 }
 
 type mockDuration struct {

observable.go

@@ -202,7 +202,7 @@ func runSeq(ctx context.Context, next chan Item, iterable Iterable, operatorFact
 		observe := iterable.Observe(opts...)
 		operator := operatorOptions{
 			stop: func() {
-				if option.getErrorStrategy() == Stop {
+				if option.getErrorStrategy() == StopOnError {
 					stopped = true
 				}
 			},
@@ -251,7 +251,7 @@ func runPar(ctx context.Context, next chan Item, iterable Iterable, operatorFact
 			stopped := false
 			operator := operatorOptions{
 				stop: func() {
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						stopped = true
 					}
 				},
@@ -281,7 +281,7 @@ func runPar(ctx context.Context, next chan Item, iterable Iterable, operatorFact
 			stopped := false
 			operator := operatorOptions{
 				stop: func() {
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						stopped = true
 					}
 				},

observable_operator.go

@@ -468,7 +468,7 @@ func (o *ObservableImpl) BufferWithTime(timespan Duration, opts ...Option) Obser
 				}
 				if item.Error() {
 					item.SendCtx(ctx, next)
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						return
 					}
 				} else {
@@ -515,7 +515,7 @@ func (o *ObservableImpl) BufferWithTimeOrCount(timespan Duration, count int, opt
 				}
 				if item.Error() {
 					item.SendCtx(ctx, next)
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						return
 					}
 				} else {
@@ -628,7 +628,7 @@ func (o *ObservableImpl) Debounce(timespan Duration, opts ...Option) Observable
 					if !item.SendCtx(ctx, next) {
 						return
 					}
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						return
 					}
 				} else {
@@ -1046,7 +1046,7 @@ func (o *ObservableImpl) FlatMap(apply ItemToObservable, opts ...Option) Observa
 						}
 						if item.Error() {
 							item.SendCtx(ctx, next)
-							if option.getErrorStrategy() == Stop {
+							if option.getErrorStrategy() == StopOnError {
 								return
 							}
 						} else {
@@ -2326,7 +2326,7 @@ func (o *ObservableImpl) TimeInterval(opts ...Option) Observable {
 					if !item.SendCtx(ctx, next) {
 						return
 					}
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						return
 					}
 				} else {
@@ -2595,7 +2595,7 @@ func (o *ObservableImpl) WindowWithTime(timespan Duration, opts ...Option) Obser
 					if !item.SendCtx(ctx, ch) {
 						return
 					}
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						close(ch)
 						return
 					}
@@ -2654,7 +2654,7 @@ func (o *ObservableImpl) WindowWithTimeOrCount(timespan Duration, count int, opt
 					if !item.SendCtx(ctx, ch) {
 						return
 					}
-					if option.getErrorStrategy() == Stop {
+					if option.getErrorStrategy() == StopOnError {
 						close(ch)
 						return
 					}

observable_operator_test.go

@@ -441,7 +441,7 @@ func Test_Observable_Errors_MultipleErrorFromMap(t *testing.T) {
 			return nil, errBar
 		}
 		return i, nil
-	}, WithErrorStrategy(Continue)).Errors()
+	}, WithErrorStrategy(ContinueOnError)).Errors()
 	assert.Equal(t, 2, len(errs))
 }
 
@@ -946,7 +946,7 @@ func Test_Observable_Reduce_Parallel_WithErrorStrategy(t *testing.T) {
 			return elem.(int), nil
 		}
 		return 0, errFoo
-	}, WithCPUPool(), WithErrorStrategy(Continue))
+	}, WithCPUPool(), WithErrorStrategy(ContinueOnError))
 	Assert(context.Background(), t, obs, HasItem(50015000), HasError(errFoo))
 }
 
@@ -1473,7 +1473,7 @@ func Test_Observable_WindowWithTime_Eager(t *testing.T) {
 
 func Test_Observable_WindowWithTime_ContinueOnError(t *testing.T) {
 	ctx, obs, d := timeCausality(1, 2, errFoo, 3, tick, 4, tick)
-	observe := obs.WindowWithTime(d, WithContext(ctx), WithBufferedChannel(10), WithErrorStrategy(Continue)).
+	observe := obs.WindowWithTime(d, WithContext(ctx), WithBufferedChannel(10), WithErrorStrategy(ContinueOnError)).
 		Observe()
 	Assert(context.Background(), t, (<-observe).V.(Observable), HasItems(1, 2, 3), HasError(errFoo))
 	Assert(context.Background(), t, (<-observe).V.(Observable), HasItems(4), HasNoError())
@@ -1508,7 +1508,7 @@ func Test_Observable_WindowWithTimeOrCount_Eager(t *testing.T) {
 
 func Test_Observable_WindowWithTimeOrCount_ContinueOnError(t *testing.T) {
 	ctx, obs, d := timeCausality(1, 2, 3, tick, 4, 5, 6, 7, tick, 8, tick)
-	observe := obs.WindowWithTimeOrCount(d, 2, WithContext(ctx), WithErrorStrategy(Continue)).Observe()
+	observe := obs.WindowWithTimeOrCount(d, 2, WithContext(ctx), WithErrorStrategy(ContinueOnError)).Observe()
 	Assert(context.Background(), t, (<-observe).V.(Observable), HasItems(1, 2))
 	Assert(context.Background(), t, (<-observe).V.(Observable), HasItems(3))
 	Assert(context.Background(), t, (<-observe).V.(Observable), HasItems(4, 5))
@@ -1574,7 +1574,7 @@ func Test_Observable_Option_WithOnErrorStrategy_Single(t *testing.T) {
 				return nil, errFoo
 			}
 			return i, nil
-		}, WithErrorStrategy(Continue))
+		}, WithErrorStrategy(ContinueOnError))
 	Assert(context.Background(), t, obs, HasItems(1, 3), HasError(errFoo))
 }
 
@@ -1591,7 +1591,7 @@ func Test_Observable_Option_WithOnErrorStrategy_Propagate(t *testing.T) {
 				return nil, errBar
 			}
 			return i, nil
-		}, WithErrorStrategy(Continue))
+		}, WithErrorStrategy(ContinueOnError))
 	Assert(context.Background(), t, obs, HasItems(3), HasErrors(errFoo, errBar))
 }
 

types.go

@@ -60,11 +60,11 @@ const (
 type OnErrorStrategy uint32
 
 const (
-	// Stop is the default error strategy.
+	// StopOnError is the default error strategy.
 	// An operator will stop processing items on error.
-	Stop OnErrorStrategy = iota
-	// Continue means an operator will continue processing items after an error.
-	Continue
+	StopOnError OnErrorStrategy = iota
+	// ContinueOnError means an operator will continue processing items after an error.
+	ContinueOnError
 )
 
 // ObservationStrategy defines the strategy to consume from an Observable.