Skip to content

Commit

Permalink
Remove reference to old pipeline class in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samirelanduk committed May 24, 2023
1 parent dd9e372 commit f364644
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,7 @@ Running
To run a pipeline, the ``run`` function is used. The only required
parameter is the path to the pipeline file:

>>> pipeline = nextflow.Pipeline("pipelines/my-pipeline.nf")
>>> execution = pipeline.run()
>>> pipeline = nextflow.run("pipelines/my-pipeline.nf")

This will return an ``Execution`` object, which represents the pipeline
execution that just took place (see below for details on this object). You can
Expand Down
3 changes: 1 addition & 2 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ Running
To run a pipeline, the :py:func:`.run` function is used. The only required
parameter is the path to the pipeline file:

>>> pipeline = nextflow.Pipeline("pipelines/my-pipeline.nf")
>>> execution = pipeline.run()
>>> pipeline = nextflow.run("pipelines/my-pipeline.nf")

This will return an :py:class:`.Execution` object, which represents the pipeline
execution that just took place (see below for details on this object). You can
Expand Down

0 comments on commit f364644

Please sign in to comment.