Improve symbolic operators documentation

[tdupu]

In Sage 9.7.beta8, the docstring for the parameter_set
method of function derivative operators has an example
but no description.

To see this:

sage: y = function('y')(x)
sage: yd = diff(y, x)
sage: op = yd.operator()
sage: op.parameter_set?
Signature:      op.parameter_set()
Docstring:
   EXAMPLES:

      sage: from sage.symbolic.operators import FDerivativeOperator
      sage: f = function('foo')
      sage: op = FDerivativeOperator(f, [0,1])
      sage: op.parameter_set()
      [0, 1]
Init docstring: Initialize self.  See help(type(self)) for accurate signature.
File:           .../sage/symbolic/operators.py
Type:           method}}}

The regulations for documentation strings can be found here:

• https://doc.sagemath.org/html/en/developer/coding_basics.html

CC: @slel

Component: documentation

Author: Samuel Lelièvre

Branch/Commit: 27579d6

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/34128

[slel]

comment:1

Thanks for the report. Here is a tentative improvement. Please review.

---

New commits:

27579d6

34128: Improve documentation of symbolic operators

[slel]

Branch: u/slelievre/34128

[slel]

Author: Samuel Lelièvre

[slel]

Commit: 27579d6

[mkoeppe]

comment:2

LGTM

[mkoeppe]

Reviewer: Matthias Koeppe

[vbraun]

Changed branch from u/slelievre/34128 to 27579d6