Skip to content

Update docstring for StreamlineOutput #1106

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.

Sign up for GitHub

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 28, 2025
Merged

Update docstring for StreamlineOutput #1106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions flow360/component/simulation/outputs/outputs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,8 +926,8 @@ class StreamlineOutput(Flow360BaseModel):
Example
-------

Define a :class:`StreamlineOutput` with streaptraces originating from points, lines (PointArray), and
parallelograms (PointArray2D).
Define a :class:`StreamlineOutput` with streaptraces originating from points,
lines (:class:`~flow360.PointArray`), and parallelograms (:class:`~flow360.PointArray2D`).

- :code:`Point_1` and :code:`Point_2` are two specific points we want to track the streamlines.
- :code:`Line_streamline` is from (1,0,0) * fl.u.m to (1,0,-10) * fl.u.m and has 11 points,
Expand Down Expand Up @@ -972,10 +972,10 @@ class StreamlineOutput(Flow360BaseModel):
entities: EntityList[Point, PointArray, PointArray2D] = pd.Field(
alias="streamline_points",
description="List of monitored :class:`~flow360.Point`/"
+ ":class:`~flow360.PointArray`/:class:`~flow360.Point`"
+ ":class:`~flow360.PointArray`/:class:`~flow360.PointArray2D` "
+ "entities belonging to this "
+ "streamline group. :class:`~flow360.PointArray` "
+ "is used to define streamline originating along a line."
+ "is used to define streamline originating along a line. "
+ ":class:`~flow360.PointArray2D` "
+ "is used to define streamline originating from a parallelogram.",
)
Expand Down