update FRD class name to fix MacOS sphinx build problems#326
Merged
Conversation
Member
Author
|
@repagh If you have a chance, it would be useful to get your input on this PR, which modifies the FRD class that you created quite a while back. |
Member
Author
|
Going ahead and merging this since it does not change the user interface. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As described in issue #299, when building the documentation on operating systems whose file systems are not case sensitive (eg, MacOS) the use of
FRDandfrdas different objects causes problems. This PR changes the class for frequency response data (FRD) systems to beFrequencyResponseData(instead ofFRD) while at the same time makingFRDbe an alias (copy) of the class => backwards compatible. This fixing the documentation issue on MacOS and allows all previous code to run.The only visible change is that the documentation now says
FrequencyResponseDataas the name of the class instead ofFRD(which may be a feature).