search

JuliaPy / SymPy.jl

Julia interface to SymPy via PyCall
http://juliapy.github.io/SymPy.jl/
MIT License
268 stars 62 forks source link

add help #433

Closed jverzani closed 2 years ago

jverzani commented 3 years ago

via SymPy.py"""help()"""

However, it has some usage quirks that might need explanation.

AshtonSBradley commented 2 years ago

A related suggestion: at present in 1.7, if I do ?SymPy at the REPL:

julia> using SymPy

help?> SymPy
search: SymPy sympy sympy_core sympy_plotting sympy_matrices sympify

  SymPy package to interface with Python's SymPy library
  (http://www.sympy.org) through PyCall.

  The basic idea is that a new type – Sym – is made to hold symbolic objects.
  For this type, the basic functions from SymPy and appropriate functions of
  Julia are overloaded for Sym objects so that the expressions are treated
  symbolically and not evaluated immediately. Instances of this type are
  created by the constructor Sym, the function symbols or the macro @vars.

  On loading, a priviledged set of the functions from the sympy module are
  defined as generic functions with their first argument narrowed to symbolic
  types. Others may be accessed by qualification, as in sympy.trigsimp.
  Calling import_from(sympy) will import the rest. SymPy methods are called
  through Python's dot-call syntax. To find documentation on SymPy functions
  and methods, one should refer to SymPy's website
  (http://docs.sympy.org/latest/index.html).

  Plotting is provided through Plots recipes. For details, see the help page
  for sympy_plotting.

  The package documentation provides many examples.

which is a great place to start. Would it make sense to link to the SymPy.jl documentation here also? Personally I find the SymPy.jl docs much easier to parse than http://docs.sympy.org/latest/index.html.

jverzani commented 2 years ago

Good idea. I believe that text is in /src/SymPy.jl I’d love a PR with suggested changes.

jverzani commented 2 years ago

Closed by #457