Skip to content

Commit

Permalink
improving changelog/185.breaking.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Nabil Freij <[email protected]>
  • Loading branch information
Ghaithq and nabobalis authored Feb 27, 2024
1 parent 3bbed10 commit 521340c
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions changelog/185.breaking.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
The ``Asda`` and ``Lamb_Oseen`` classes have been removed and replaced with functions that replicate the original process.

The following function were renamed:
- gen_vel -> generate_velocity_field
- gamma_values -> calculate_gamma_values
- vortex_property -> get_vortex_properties
- ``gen_vel`` -> ``generate_velocity_field``
- ``gamma_values`` -> ``calculate_gamma_values``
- ``vortex_property`` -> ``get_vortex_properties``

Now to use, the properties that were previously stored within the class should now be passed through the arguments of the methods in case the method used these arguments.
Ex: lo.gen_vel(index[1], index[0]) -> asda.generate_velocity_field(vx, vy, index[1], index[0], r)

Example:

``lo.gen_vel(index[1], index[0])`` -> ``asda.generate_velocity_field(vx, vy, index[1], index[0], r)``

0 comments on commit 521340c

Please sign in to comment.