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 missing or incomplete for many API/doc sections. #327

Open
remy-luisant opened this issue Jun 21, 2023 · 1 comment
Open

Comments

@remy-luisant
Copy link

I have noticed that the website does not have the qdetector documented. There are others, too. Multichannel comes to mind.

I will not give the whole list here. Suffice to say, this has been a grave problem in quickly moving around the library. (I no longer need the details on the two, I'm merely reporting the lack of documentation as a former impediment.)

The problem spans both the doc and the api tabs. The two are also drifting out of sync with each other, it seems.

@jgaeddert
Copy link
Owner

Fair point, and I've been (slowly) trying to synchronize them and complete missing pieces. I can prioritize the qdetector object and multichannel module.

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

2 participants