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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve documentation: make message queue cleaning clearer #122
Improve documentation: make message queue cleaning clearer #122
Conversation
hmmm I think the part in test_ping : assert dpytest.verify().message().contains().content("Ping:")
await dpytest.empty_queue() # empty the global message queue as test teardown can be confusing, for new users. We definitly need to warn users that this problem can occur, and provide that information, but I think it would be better if it's after the "basic use case" without it. I think we can keep the examples simple and straightforward, as they are, and right after, write somethint like "one problem that could happen is that the sent_queue is shared between the tests, so in order to not mess between your tests (verify() pops one message from the queue, so in general, you won't need to do anything, but if you have any issues, you can explicitly call empty_queue, as shown in the next example (and later, in the conftests.py) something like that, I think |
I really like your idea! I'll change it that way |
Could you just confirm that the syntax I used in db1d9cd won't be a problem? |
It's better to let the basic use case, well, basic This reverts commit a99a026.
@ctmbl yeah, it's OK, '-' will make a bulleted list I'll add the makefile and make.bat for the doc, so everyone can build and test (either on Windows or Unix) And the tasks for invoke, so you'll just need to type |
Should fix #116
According to me, this is the least that should be done to help the new user deal with message queue, the must would be to perform it automatically.
However I'm still not sure about a few changes:
send_queue
,error_queue
?I separated my changes in different commits to help you walking through the reviewing process.
Don't hesitate to reject or discuss any changes I propose 馃槈