Rename internal functions in wfdb.plot.plot #386
Merged
Conversation
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
added 8 commits
June 7, 2022 10:14
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
cx1111
approved these changes
Jun 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A lot of functions in the package are only for the use of other functions in the package. Their interfaces are complicated, low-level, and generally not very useful to applications, so we want to make it clear that these functions are not part of the package API and their interfaces may change at any time.
The following functions in wfdb.plot.plot do not appear to be designed for applications to use:
(get_plot_dims and create_figure have unit tests but nonetheless don't seem to be designed for application use. get_plot_dims is very implementation-specific, and create_figure is a handy but ultimately trivial wrapper around the (admittedly bonkers) matplotlib API.)
Rename these functions to indicate they are internal to the package.