Esta página aún no se ha traducido para esta versión. Puede ver la versión más reciente de esta página en inglés.

Obtén ayuda para las funciones deMATLABPython

Cómo encontrar ayudaMATLAB

Desde, puede acceder a la documentación de soporte para todas las funciones.Python®MATLAB® Esta documentación incluye ejemplos y describe los argumentos de entrada, los argumentos de salida y la sintaxis de llamada para cada función.

La API del motor permite utilizar las funciones y.MATLABPythonMATLABdochelp Se usa para abrir el explorador de ayuda.docMATLAB Se usa para obtener una breve descripción de una función en el símbolo del sistema.helpMATLABPython

Abra el navegador de ayuda desdeMATLABPython

Desde, puede usar el explorador de ayuda para abrir páginas de referencia de función y buscar en la documentación.PythonMATLAB

Por ejemplo, muestre la página de referencia de la función.MATLABplot (Dado que no devuelve ningún argumento de salida, debe establecer.)docnargout=0

import matlab.engine eng = matlab.engine.start_matlab() eng.doc("plot",nargout=0) 

La página de referencia incluye una descripción de la función, ejemplos y vínculos a la documentación relacionada.

Nota

Haga clic en un título de ejemplo o en la flecha situada junto a un título, si no ve los ejemplos en una página de referencia.MATLAB Los ejemplos se pueden contraer o expandir dentro de una página.

Si llama sin argumentos posicionales, se abre el explorador de ayuda.eng.doc (Todavía debe establecer el argumento de palabra clave).nargout=0

eng.doc(nargout=0) 

Para buscar en la documentación, escriba una expresión en el cuadro de búsqueda en la parte superior de cualquier página en el explorador de ayuda.MATLAB El explorador devuelve una lista de resultados de búsqueda, resaltando las palabras que coinciden con la expresión.

Alternativamente, puede buscar la documentación con la función.docsearch Por ejemplo, busque las páginas que mencionan.plot

eng.docsearch("plot",nargout=0) 

Mostrar ayuda en promptMATLABPython

Para mostrar el texto de ayuda de una función en el símbolo del sistema, llame a la función.PythonMATLABhelp Por ejemplo, para mostrar el texto de ayuda.erf

import matlab.engine eng = matlab.engine.start_matlab() eng.help("erf",nargout=0) 
 ERF Error function.     Y = ERF(X) is the error function for each element of X.  X must be     real. The error function is defined as:         erf(x) = 2/sqrt(pi) * integral from 0 to x of exp(-t^2) dt.       See also ERFC, ERFCX, ERFINV, ERFCINV.      Other functions named erf:        codistributed/erf        gpuArray/erf        sym/erf      Reference page in Help browser        doc erf 

La salida muestra el texto de ayuda, pero no incluye ningún vínculo para ayudar a otras funciones que puedan mencionarse.MATLAB