Skip to content
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

Documentation for nested methods #5

Closed
Hazboun6 opened this issue Apr 20, 2017 · 2 comments
Closed

Documentation for nested methods #5

Hazboun6 opened this issue Apr 20, 2017 · 2 comments
Labels

Comments

@Hazboun6
Copy link
Contributor

I've added in a file of plotting functions, PSS_plot.py, that I've been populating with common pots the user might want as they play with the signal. I've added the methods to the Signal class so that all ones needs to do is call the plot type and the function uses the dictionary to build a nice looking plot with the correct parameters. However, the normal docstring that appears, and more importantly the nice help one gets when in a jupyter noteboook (shift+tab, where the full signature appears with all of the needed variables) does not appear. The command sitting in signal.py appears instead. Since these plotting functions have a number of options it would be nice for this to appear. Any thoughts?

bshapiroalbert referenced this issue in bshapiroalbert/PsrSigSim Oct 21, 2019
update from PTB's new-API branch
bshapiroalbert added a commit that referenced this issue Feb 6, 2020
@bshapiroalbert
Copy link
Contributor

@Hazboun6 is this still relevant or should we close it?

@Hazboun6
Copy link
Contributor Author

Hazboun6 commented Aug 6, 2020

It's sort of relevant, but maybe should have been a question posed to StackExchange rather than as an issue? I think we can get around this by making the plotting scripts be classes rather than methods, so that the docstrings will just get inherited. I will close the issue.

@Hazboun6 Hazboun6 closed this as completed Aug 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants