Skip to content

Commit ff5c54b

Browse files
Changefluentdoc (#389)
Co-authored-by: Roberto Pastor Muela <[email protected]>
1 parent fc15037 commit ff5c54b

File tree

5 files changed

+11
-8
lines changed

5 files changed

+11
-8
lines changed

doc/source/examples/dynamic_sketch_plane.mystnb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The sketch is a lightweight, two-dimensional modeler driven primarily by client-
1818
At any point, the current state of a sketch can be used for operations such as extruding a body,
1919
projecting a profile, or imprinting curves.
2020

21-
The sketch is designed as an effective Fluent-style API with all operations receiving 2D configurations.
21+
The sketch is designed as an effective 'fluent functional-style' API with all operations receiving 2D configurations.
2222

2323
For easy reuse of sketches across different regions of your design, you can move a sketch around the
2424
global coordinate system by modifying the plane defining the current sketch location.

doc/source/examples/plate_with_hole.mystnb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ kernelspec:
1515

1616
You can create multiple bodies from a single sketch by extruding the same sketch in different planes.
1717

18-
The sketch is designed as an effective Ansys Fluent-style API with all operations receiving 2D configurations.
19-
To know more about the Fluent API, see [Fluent-based approach (Fluent API) in Sketch](../user_guide/shapes.rst).
18+
The sketch is designed as an effective 'fluent functional-style' API with all operations receiving 2D configurations.
19+
To know more about the API, see [Fluent functional-style API in Sketch](../user_guide/shapes.rst).
2020

2121
In this example, a box is located in the center of the plate, with the default origin of a sketch plane (origin at ``(0, 0, 0)``).
2222
Four holes of equal radius are sketched at the corners of the plate.

doc/source/user_guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ PyGeometry is a Python wrapper for the Ansys Geometry service.
2323
The key features of PyGeometry are:
2424

2525
* Ability to use the library alongside other Python libraries
26-
* Fluent based API for a clean and easy coding experience
26+
* A 'fluent functional-style' API for a clean and easy coding experience
2727
* Built-in examples
2828

2929
Simple interactive example

doc/source/user_guide/shapes.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ You can initialize the sketch by:
2222
2323
The sketch can be constructed using different approaches.
2424

25-
Fluent-based approach (Fluent API)
26-
==================================
25+
Functional-style API
26+
====================
27+
28+
This is sometimes termed a 'fluent functional-style api, or fluent API' in the developer community. We avoid
29+
that term in the context of Ansys APIs to avoid confusion with the Ansys Fluent product.
2730

2831
One of the key features of this approach is keeping an active context based upon the previously created
2932
edges to use as a reference start point for additional objects.

tests/test_sketch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ def test_sketch_segment_edge():
5454
# Create a Sketch instance
5555
sketch = Sketch()
5656

57-
# fluent api has 0, 0 origin as default start position
57+
# sketch api has 0, 0 origin as default start position
5858
assert len(sketch.edges) == 0
5959
sketch.segment_to_point(Point2D([2, 3]), "Segment1")
6060
assert len(sketch.edges) == 1
6161
assert sketch.edges[0].start == ZERO_POINT2D
6262
assert sketch.edges[0].end == Point2D([2, 3])
6363
assert sketch.edges[0].length.m == pytest.approx(3.60555128, rel=1e-7, abs=1e-8)
6464

65-
# fluent api keeps last edge endpoint as context for new edge
65+
# sketch api keeps last edge endpoint as context for new edge
6666
sketch.segment_to_point(Point2D([3, 3]), "Segment2").segment_to_point(
6767
Point2D([3, 2]), "Segment3"
6868
)

0 commit comments

Comments
 (0)