Skip to content

Commit

Permalink
Wording changes
Browse files Browse the repository at this point in the history
  • Loading branch information
saantiaguilera committed Feb 10, 2020
1 parent 99846a5 commit 2cfdad5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Go-Pipeline
# Pipeline

![Build Status](https://github.com/saantiaguilera/go-pipeline/workflows/Go/badge.svg)
[![Coverage](https://codecov.io/gh/saantiaguilera/go-pipeline/branch/master/graph/badge.svg)](https://codecov.io/gh/saantiaguilera/go-pipeline)
Expand Down
13 changes: 6 additions & 7 deletions pipeline.go
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
/*
Package pipeline is a pure Go client library for building pipelines in a declarative way.
It includes a high level API to easily build, execute and draw a graph/template of a desired structure.
Package pipeline is a pure Go client library for building and executing pipelines in a declarative way.
It includes a high level API to easily build, execute and draw graphs of a desired structure.
If the defined implementations of the API are insufficient, one can create their own implementation adding new behaviours,
such as circuit-breaker executors, panic recover executors, new-relic step decorators, among any idea or feature you would
like.
If the defined implementations of the API are insufficient, one can create their own implementations adding new behaviours,
such as circuit-breakers, panic recovers, APM decorators, custom stages, custom steps, etc.
Supported structure
Below you can find the atomic types this API exposes. This elements are mandatory for creating and executing a graph in a pipeline.
Below you can find the atomic types this API exposes. These elements are mandatory for creating and executing a graph in a pipeline.
Context
A context is supplied across all the graph flow for communicating data across different units of work. This is useful when
A context is supplied across all the graph for communicating data across different units of work. This is useful when
having single graph instances and reusing them constantly (thus having stateless elements besides the injected behaviours).
Step
Expand Down
2 changes: 1 addition & 1 deletion pipeline_benchmark_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ func Test_GraphRendering(t *testing.T) {
// Also, the graph contains all conditionals returning the "worse" possible path (the largest way)
//
// The current graph has 112 steps (chan/int/string), the UML can be seen at pipeline_benchmark_test.svg
// Output: BenchmarkPipeline_Run-4 40408 31035 ns/op (0.031ms)
// Output: BenchmarkPipeline_Run-4 46436 26635 ns/op (0.026ms)
// Given this graph magnitude, the cost of traversing it is negligible in comparison to a step operation.
func BenchmarkPipeline_Run(b *testing.B) {
pipe := pipeline.CreatePipeline(SimpleExecutor{})
Expand Down

0 comments on commit 2cfdad5

Please sign in to comment.