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.
Replacing #759, resolves #722
The core functionality works by taking a list of class names where the docstrings are located, scanning through each property and method that matches a key in the DEFAULTS dictionary, and then outputting a dictionary with the appropriate tooltip.
For example, in
defaults.py
we can have something like:When we call:
the function iterates through each property and method in the two classes until it finds:
It then appends the extracted docstring to the output dictionary, resulting in something like:
Note: The tooltips are not added to the distribution/lattice configuration sections. A separate PR is needed to update defaults.py with the correct defaults to enable tooltips for those sections.