Deprecation Warning leading to v.2.0.0 #220
Conversation
|
|
||
| warnings.warn( | ||
| "shape_to_msh_t is deprecated and will be removed. " | ||
| "Consider using 'utils.get_mesh_polygons' or 'MeshData' from geometry.", |
There was a problem hiding this comment.
I'm not sure what you mean to say by "MeshData" from geometry. We now have .geoseries() for geometry, we don't have meshdata. Also one additional not is that we will still have shape_to_msh_t in v2.0, but it's now in the jigsaw engine module.
ocsmesh/__init__.py
Outdated
| " You must install them manually if needed.\n" | ||
| "2. A new default mesh engine will be adopted to replace Jigsaw.\n" | ||
| "3. 'jigsaw_msh_t' has been replaced by 'ocsmesh.internal.MeshData'.\n" | ||
| "4. Functions operating on msh_t objects are deprecated and will be updated to support meshdata.\n" |
There was a problem hiding this comment.
To support MeshData (camel case)
ocsmesh/__init__.py
Outdated
| "2. A new default mesh engine will be adopted to replace Jigsaw.\n" | ||
| "3. 'jigsaw_msh_t' has been replaced by 'ocsmesh.internal.MeshData'.\n" | ||
| "4. Functions operating on msh_t objects are deprecated and will be updated to support meshdata.\n" | ||
| "Please check the release notes and update your workflows accordingly.\n" |
There was a problem hiding this comment.
Are you going to add more details about upcoming v2 in release notes? Or are you referring to v2 release notes when it's released?
| """ | ||
| warnings.warn( | ||
| "JigsawDriver is deprecated and will be removed in a future release. " | ||
| "Please use 'ocsmesh.driver.MeshDriver' with engine_name='jigsaw'." |
There was a problem hiding this comment.
I think we should change the wording a little bit since this version doesn't have MeshDriver yet
| warnings.warn( | ||
| "JigsawDriver is deprecated and will be removed in a future release. " | ||
| "Please use 'ocsmesh.driver.MeshDriver' with engine_name='jigsaw'." | ||
| "We strongly suggest the adoption of gmsh and the driver engine", |
There was a problem hiding this comment.
Maybe rephrase to "we suggest considering Gmsh for your workflow as the that's going to be the default for OCSMesh in the upcoming versions." or something like that
|
|
||
| warnings.warn( | ||
| "JigsawDriver.run() is deprecated. " | ||
| "Use MeshDriver.run() instead.", |
There was a problem hiding this comment.
Again I'm not sure if having a reference to something that will be added later is going to be helpful or not
|
I think we should add warnings to Geom and Hfun msh_t methods and properties as well |
|
All utils functions (more or less) use |
Added warnings.
@SorooshMani-NOAA, for simplicity I think we should focus on the init warning.
Adding warnings on each function will be too time consuming (although I did for the utils and driver).