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

Including Signal2D/ BaseSignal methods in Documentation #1068

Open
CSSFrancis opened this issue May 3, 2024 · 0 comments
Open

Including Signal2D/ BaseSignal methods in Documentation #1068

CSSFrancis opened this issue May 3, 2024 · 0 comments

Comments

@CSSFrancis
Copy link
Member

Is your feature request related to a problem? Please describe.
@hakonanes had a good comment about including parent methods in the documentation in diffsims and it got me thinking should we include the Signal2D/ BaseSignal methods in the documentation?

I could see how adding the Signal2D methods might really crowd the namespace but it might also be good to have those methods included in the documentation so people don't have to go upstream to hyperspy. Maybe something like separate the methods such that they go:

DiffractionSignal Methods:

....


------------
Parent Methods: 
(Links to outside)
....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant