Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor dep-div-indep hint #21588

Merged
merged 11 commits into from Jun 12, 2021
10 changes: 6 additions & 4 deletions doc/src/modules/solvers/ode.rst
Expand Up @@ -81,15 +81,17 @@ factorable

1st_homogeneous_coeff_best
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: sympy.solvers.ode.ode::ode_1st_homogeneous_coeff_best
.. autofunction:: sympy.solvers.ode.single::HomogeneousCoeffBest

1st_homogeneous_coeff_subs_dep_div_indep
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: sympy.solvers.ode.ode::ode_1st_homogeneous_coeff_subs_dep_div_indep
.. autoclass:: sympy.solvers.ode.single::HomogeneousCoeffSubsDepDivIndep
:members:

1st_homogeneous_coeff_subs_indep_div_dep
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: sympy.solvers.ode.ode::ode_1st_homogeneous_coeff_subs_indep_div_dep
.. autoclass:: sympy.solvers.ode.single::HomogeneousCoeffSubsIndepDivDep
:members:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do some autoclass blocks have members but others not?

Is it useful to show the members?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

official documentation says if we keep the :members: block then it will include docstrings of member functions also. but in previous class like Factorable, initially it was not there but someone made commit stating 'expanding documentation', so I thought it is the practice to be followed.


1st_linear
^^^^^^^^^^
Expand Down Expand Up @@ -152,7 +154,7 @@ almost_linear

linear_coefficients
^^^^^^^^^^^^^^^^^^^
.. autofunction:: sympy.solvers.ode.ode::ode_linear_coefficients
.. autofunction:: sympy.solvers.ode.single::LinearCoefficients
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be autoclass?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, this should be autoclass. will rectify it


separable_reduced
^^^^^^^^^^^^^^^^^
Expand Down