DOC: exclude Dataset.prop #87
Merged
Conversation
This file contains 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
hagenw
added a commit
that referenced
this pull request
Apr 26, 2024
hagenw
added a commit
that referenced
this pull request
Apr 30, 2024
* Speed up caching of audbcards.Dataset * Try to fix * Another fix * Improve execution after loading from cache * Use hidden attributes * Add audbcards.Dataset.schemes_summary * Ensure header and deps are loaded on the fly * Add docstring example * Readd self.cache_root * Do not test docstrings of sphinx extension * Ensure everything is loaded, starting from cache * Improve code and tests * Remove doctest * Re-enable test for same header * Rename Dataset.properties() to cached_properties() * Rename cached_properties() to _cached_properties() * Fix inclusion of properties in API docs * Revert changes handled in #87 * Include cache_root in API docs * Improve docstring of repository_object * Fix docstring of backend * Remove Artifactory related pragma
ChristianGeng
approved these changes
Apr 30, 2024
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.
Closes #85
This makes sure the class variable
audbcards.Dataset.propsis not documented in the API docs, by renaming it to_props.