Skip to content
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.

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

Deprecated functions and variables for v1.0 #139

Open
akabla opened this issue Aug 19, 2021 · 4 comments
Open

Deprecated functions and variables for v1.0 #139

akabla opened this issue Aug 19, 2021 · 4 comments
Milestone

Comments

@akabla
Copy link
Member

akabla commented Aug 19, 2021

This is to record functions and variables that are now deprecated - to be removed with version 1.0 of RHEOS.

When adding an item to this list, check that:

  • docs are updated accordingly, and the docs/src/API.md links to the right functions.
  • examples are updated accordingly
@akabla akabla added this to the 1.0.0 milestone Aug 19, 2021
@akabla
Copy link
Member Author

akabla commented Aug 19, 2021

The functions onlytime, onlystress, onlystrain and onlyfreq now replace extract, which is deprecated.
#23

@akabla
Copy link
Member Author

akabla commented Aug 19, 2021

Function freezeparams replaces freeze_params.

@moustachio-belvedere
Copy link
Member

Can we add a subtask to this list to update the API section of docs to add remove functions as needed?

@akabla
Copy link
Member Author

akabla commented Aug 21, 2021

Can we add a subtask to this list to update the API section of docs to add remove functions as needed?

Thanks Louis, this is definitely part of the workflow.

I think we should update the docs as soon as the new syntax is introduced, rather than when we remove the deprecated functions. This is to encourage the use of the new functions from now on. I already changed freezeparams. The doc exists for the others and example files have been updated too. I forgot indeed to change the API file of the doc... back on the list!

akabla added a commit that referenced this issue Aug 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants