-
Notifications
You must be signed in to change notification settings - Fork 227
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
Removing Dead, Deprecated, and Unreachable Code #975
Comments
#1021 mentions some to get rid of |
I couldn't find a place where the attribute The |
I just thought we might want to deprecate the |
Does anyone use RMG-Java? |
I agree with deprecating RMG-Java methods. See #1021 for additional discussion related to this. |
As far as I'm aware, we don't have a existing deprecation process. It might be good to start one though. I think for typical software projects, deprecation means that a feature is no longer supported or recommended for use. Complete removal of the feature is done later on a fixed timeline. This might be difficult for us though, since we don't have a fixed release schedule. A possible plan for us might be to add the deprecation warning in one release, then remove the method in the next release. Unless we start making small releases more often, in which case we could have a couple releases between deprecation and removal. |
I was too fast to vote for removing on #1021. I agree that we should develop a deprecation process. |
We may also want to deprecate the non-web versions of scripts like |
Perhaps allowSingletO2 option in the input file can now be depreciated. |
We could also depreciate the |
I'd add group additivity methods in 'family.py' to the list of deprecatable methods. |
We could deprecate the FAME (used in RMG-Java) to CanTherm/Arkane file type converter. |
I wanted to add a few more things to this thread:
|
Searching for warnings.warn("X is no longer supported and may be"
" removed in version 2.3.", DeprecationWarning) results. Shall we go ahead and remove these functions, given that v 3.0.0 was just released? |
Here is a list of methods which should (allegedly) be deleted: link |
The |
Done in #2448 |
I am curious if we want to deprecate any functionality in RMG. I am thinking that not-often-used and poorly understood functionalities could be removed to allow easier bug checking, code support, and development. We may also be able to just cut some redundant methods. One example I came across would be to remove the method
rmgpy/molecule/molecule/Bond/isSpecificCaseOf
and integrate its code intormgpy/molecule/molecule/Bond/equivalent
.If people think it may be worthwhile to have a list of methods to cut, we may want to have a warning placed in docStrings, similar to how Cantera placed some in their code to warn users.
The text was updated successfully, but these errors were encountered: