Skip to content

Correct docstring related to minimum version in new features #1071

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 4 commits into from
Jul 26, 2023
Merged

Correct docstring related to minimum version in new features #1071

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
61f7728
Correct docstring related to minimum version in new features
MichaelNale Jul 26, 2023
d6f7b1b
Update the PR : correct the Ansys install version
MichaelNale Jul 26, 2023
0d0f0af
Merge branch 'master' into mnale/min_version_doc_meshinfo
MichaelNale Jul 26, 2023
9f3b19c
Merge branch 'master' into mnale/min_version_doc_meshinfo
MichaelNale Jul 26, 2023
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
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/any.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class Any:

Notes
-----
Class available with server's version starting at 6.2 (Ansys 2024R1).
Class available with server's version starting at 7.0 (Ansys 2024 R1 pre0).
"""

def __init__(self, any_dpf=None, server=None):
Expand Down
6 changes: 6 additions & 0 deletions src/ansys/dpf/core/faces.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ class Face:
>>> face.nodes[0].coordinates
[-0.030426240620025163, -0.05908951107677226, -0.034248966723680496]

Notes
-----
Class available with server's version starting at 7.0 (2024 R1 pre0).
"""

def __init__(self, mesh, faceid, index, nodes):
Expand Down Expand Up @@ -210,6 +213,9 @@ class Faces:
>>> faces.n_faces
44242

Notes
-----
Class available with server's version starting at 7.0 (2024 R1 pre0).
"""

def __init__(self, mesh):
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/dpf/core/generic_data_container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class GenericDataContainer:

Notes
-----
Class available with server's version starting at 6.2 (Ansys 2023R2).
Class available with server's version starting at 7.0 (Ansys 2024 R1 pre0).
"""

def __init__(self, generic_data_container=None, server=None):
Expand Down
3 changes: 3 additions & 0 deletions src/ansys/dpf/core/mesh_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ class MeshInfo:
>>> model = dpf.Model(fluent)
>>> mesh_info = model.metadata.mesh_info

Notes
-----
Class available with server's version starting at 7.0 (2024 R1 pre0).
"""

def __init__(
Expand Down