+
Skip to content

Enhance some docstrings (only minor changes) #961

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

Merged
merged 1 commit into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/felupe/mechanics/_curve.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ class CharacteristicCurve(Job):
Examples
--------
.. pyvista-plot::
:context:
:force_static:

>>> import felupe as fem
>>>
Expand All @@ -72,6 +74,11 @@ class CharacteristicCurve(Job):
... ylabel=r"Normal Force in $F_1$ in N $\rightarrow$",
... marker="o",
... )

.. pyvista-plot::
:context:
:force_static:

>>> solid.plot("Principal Values of Cauchy Stress").show()

See Also
Expand Down
1 change: 1 addition & 0 deletions src/felupe/mechanics/_free_vibration.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ class FreeVibration:
Examples
--------
.. pyvista-plot::
:force_static:

>>> import felupe as fem
>>> import numpy as np
Expand Down
1 change: 1 addition & 0 deletions src/felupe/mechanics/_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ class Job:
Examples
--------
.. pyvista-plot::
:force_static:

>>> import felupe as fem
>>>
Expand Down
8 changes: 8 additions & 0 deletions src/felupe/mechanics/_step.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class Step:
Examples
--------
.. pyvista-plot::
:force_static:

>>> import felupe as fem
>>>
Expand All @@ -58,6 +59,13 @@ class Step:
>>>
>>> job = fem.Job(steps=[step]).evaluate()
>>> ax = solid.plot("Principal Values of Cauchy Stress").show()

See Also
--------
Job : A job with a list of steps and a method to evaluate them.
CharacteristicCurve : A job with a list of steps and a method to evaluate them.
Force-displacement curve data is tracked during evaluation for a given
:class:`~felupe.Boundary`.
"""

def __init__(self, items, ramp=None, boundaries=None):
Expand Down
2 changes: 1 addition & 1 deletion src/felupe/mesh/_geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ def __init__(self, a=(0.0, 0.0), b=(1.0, 1.0), order=2):


class CubeArbitraryOrderHexahedron(Cube):
"""A rectangular 2d-mesh with an arbitrary-order Lagrange hexahedron between ``a``
"""A rectangular 3d-mesh with an arbitrary-order Lagrange hexahedron between ``a``
and ``b``.

Examples
Expand Down
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载