Skip to content

Commit

Permalink
Remove redundant information in evolve() documentation (#5347)
Browse files Browse the repository at this point in the history
**Context:**

As pointed out by @BM7878, there is some redundancy in the documentation for the `evolve()` function.

**Description of the Change:**

* Removed redundant references to classes in the `evolve()` documentation.

**Benefits:**

* The `evolve()` documentation is slightly more concise.

**Possible Drawbacks:**

_N/A_

**Related GitHub Issues:**

_N/A_
  • Loading branch information
Mandrenkov committed Mar 12, 2024
1 parent 5ffbc99 commit d095953
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
3 changes: 3 additions & 0 deletions doc/releases/changelog-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@

<h3>Documentation 📝</h3>

* Removed some redundant documentation for the `evolve` function.
[(#5347)](https://github.com/PennyLaneAI/pennylane/pull/5347)

* Updated the final example in the `compile` docstring to use transforms correctly.
[(#5348)](https://github.com/PennyLaneAI/pennylane/pull/5348)

Expand Down
10 changes: 0 additions & 10 deletions pennylane/ops/functions/evolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,6 @@ def evolve(*args, **kwargs): # pylint: disable=unused-argument
Returns:
.Evolution: evolution operator
.. seealso::
:class:`~.Evolution`
**Examples**
We can use ``qml.evolve`` to compute the evolution of any PennyLane operator:
Expand Down Expand Up @@ -83,10 +79,6 @@ def evolve(*args, **kwargs): # pylint: disable=unused-argument
The :class:`~.ParametrizedEvolution` class uses a numerical ordinary differential equation
solver (`here <https://github.com/google/jax/blob/main/jax/experimental/ode.py>`_).
.. seealso::
:class:`~.ParametrizedEvolution`
**Examples**
When evolving a :class:`.ParametrizedHamiltonian`, a :class:`.ParametrizedEvolution`
Expand Down Expand Up @@ -159,8 +151,6 @@ def circuit(params):
the first execution will typically take a little longer with the benefit that all following executions
will be significantly faster, see the jax docs on jitting. JIT-compiling is optional, and one can remove
the decorator when only single executions are of interest.
Please check the :class:`.ParametrizedEvolution` class for more usage details.
"""


Expand Down

0 comments on commit d095953

Please sign in to comment.